diff --git a/talawa-mobile-docs/__404error.md b/talawa-mobile-docs/__404error.md new file mode 100644 index 0000000000..0fedbdcfdd --- /dev/null +++ b/talawa-mobile-docs/__404error.md @@ -0,0 +1,6 @@ +# 404 + +Oops, something's gone wrong :-( + +You've tried to visit a page that doesn't exist. Luckily this site has other +[pages](index.md). diff --git a/talawa-mobile-docs/apptheme/AppTheme-class.md b/talawa-mobile-docs/apptheme/AppTheme-class.md new file mode 100644 index 0000000000..517eacb479 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme-class.md @@ -0,0 +1,347 @@ + + + +# AppTheme class + + + + + + + + + + + + + +## Constructors + +[AppTheme](../apptheme/AppTheme/AppTheme.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + +## Static Properties + +##### [bodyText1](../apptheme/AppTheme/bodyText1.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [bodyText2](../apptheme/AppTheme/bodyText2.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [bodyText3](../apptheme/AppTheme/bodyText3.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [button](../apptheme/AppTheme/button.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [headline1](../apptheme/AppTheme/headline1.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [headline2](../apptheme/AppTheme/headline2.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [headline3](../apptheme/AppTheme/headline3.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [headline4](../apptheme/AppTheme/headline4.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [headline5](../apptheme/AppTheme/headline5.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [headline6](../apptheme/AppTheme/headline6.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [overline](../apptheme/AppTheme/overline.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [subtitle1](../apptheme/AppTheme/subtitle1.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [subtitle2](../apptheme/AppTheme/subtitle2.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + +##### [title](../apptheme/AppTheme/title.md) ↔ [TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) + + + + +_read / write_ + + + + + + + + +## Constants + +##### [blackPrimary](../apptheme/AppTheme/blackPrimary-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) + + + + + + + + +##### [blackTertiary](../apptheme/AppTheme/blackTertiary-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) + + + + + + + + +##### [green](../apptheme/AppTheme/green-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) + + + + + + + + +##### [lightGrey](../apptheme/AppTheme/lightGrey-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) + + + + + + + + +##### [red](../apptheme/AppTheme/red-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) + + + + + + + + +##### [shadow](../apptheme/AppTheme/shadow-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) + + + + + + + + +##### [white](../apptheme/AppTheme/white-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/talawa-mobile-docs/apptheme/AppTheme/AppTheme.md b/talawa-mobile-docs/apptheme/AppTheme/AppTheme.md new file mode 100644 index 0000000000..4e8b04727b --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/AppTheme.md @@ -0,0 +1,24 @@ + + + +# AppTheme constructor + + + + + + + +AppTheme() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md b/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md new file mode 100644 index 0000000000..19a5f30263 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/blackPrimary-constant.md @@ -0,0 +1,32 @@ + + + +# blackPrimary constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blackPrimary + + + + + + + + +## Implementation + +```dart +static const Color blackPrimary = Color(0xFF3E3E3E); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md b/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md new file mode 100644 index 0000000000..df8a790e64 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/blackSecondary-constant.md @@ -0,0 +1,32 @@ + + + +# blackSecondary constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blackSecondary + + + + + + + + +## Implementation + +```dart +static const Color blackSecondary = Color(0xFF636363); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md b/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md new file mode 100644 index 0000000000..67e61cceeb --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/blackTertiary-constant.md @@ -0,0 +1,32 @@ + + + +# blackTertiary constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blackTertiary + + + + + + + + +## Implementation + +```dart +static const Color blackTertiary = Color(0xFFAEAEAE); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md b/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md new file mode 100644 index 0000000000..3b83107b8d --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/blue-constant.md @@ -0,0 +1,32 @@ + + + +# blue constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const blue + + + + + + + + +## Implementation + +```dart +static const Color blue = Color(0xFF2196F3); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md b/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md new file mode 100644 index 0000000000..1319aea9ae --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/bodyText1.md @@ -0,0 +1,37 @@ + + + +# bodyText1 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText1 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle bodyText1 = const TextStyle( + fontSize: 12, + fontWeight: FontWeight.w400, + color: blackSecondary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md b/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md new file mode 100644 index 0000000000..447738bd62 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/bodyText2.md @@ -0,0 +1,37 @@ + + + +# bodyText2 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText2 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle bodyText2 = const TextStyle( + fontSize: 8, + fontWeight: FontWeight.w400, + color: blackSecondary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md b/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md new file mode 100644 index 0000000000..f5b9082710 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/bodyText3.md @@ -0,0 +1,37 @@ + + + +# bodyText3 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) bodyText3 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle bodyText3 = const TextStyle( + fontSize: 10, + fontWeight: FontWeight.w400, + color: blackSecondary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/button.md b/talawa-mobile-docs/apptheme/AppTheme/button.md new file mode 100644 index 0000000000..21a7c237e1 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/button.md @@ -0,0 +1,37 @@ + + + +# button property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) button + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle button = const TextStyle( + fontSize: 16, + fontWeight: FontWeight.w600, + color: primary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/green-constant.md b/talawa-mobile-docs/apptheme/AppTheme/green-constant.md new file mode 100644 index 0000000000..c5b360b4e6 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/green-constant.md @@ -0,0 +1,32 @@ + + + +# green constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const green + + + + + + + + +## Implementation + +```dart +static const Color green = Color(0xFF2ACC00); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md b/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md new file mode 100644 index 0000000000..7823968133 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/grey-constant.md @@ -0,0 +1,32 @@ + + + +# grey constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const grey + + + + + + + + +## Implementation + +```dart +static const Color grey = Color(0xFFD2D2D2); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/headline1.md b/talawa-mobile-docs/apptheme/AppTheme/headline1.md new file mode 100644 index 0000000000..37af53874b --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/headline1.md @@ -0,0 +1,37 @@ + + + +# headline1 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline1 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle headline1 = const TextStyle( + fontSize: 24, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/headline2.md b/talawa-mobile-docs/apptheme/AppTheme/headline2.md new file mode 100644 index 0000000000..66e649046f --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/headline2.md @@ -0,0 +1,37 @@ + + + +# headline2 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline2 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle headline2 = const TextStyle( + fontSize: 18, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/headline3.md b/talawa-mobile-docs/apptheme/AppTheme/headline3.md new file mode 100644 index 0000000000..c768808929 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/headline3.md @@ -0,0 +1,37 @@ + + + +# headline3 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline3 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle headline3 = const TextStyle( + fontSize: 16, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/headline4.md b/talawa-mobile-docs/apptheme/AppTheme/headline4.md new file mode 100644 index 0000000000..003c362828 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/headline4.md @@ -0,0 +1,37 @@ + + + +# headline4 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline4 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle headline4 = const TextStyle( + fontSize: 14, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/headline5.md b/talawa-mobile-docs/apptheme/AppTheme/headline5.md new file mode 100644 index 0000000000..ef7db3e530 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/headline5.md @@ -0,0 +1,37 @@ + + + +# headline5 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline5 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle headline5 = const TextStyle( + fontSize: 12, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/headline6.md b/talawa-mobile-docs/apptheme/AppTheme/headline6.md new file mode 100644 index 0000000000..2928a6d0f8 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/headline6.md @@ -0,0 +1,37 @@ + + + +# headline6 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) headline6 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle headline6 = const TextStyle( + fontSize: 10, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md b/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md new file mode 100644 index 0000000000..2eb849d4de --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/lightGrey-constant.md @@ -0,0 +1,32 @@ + + + +# lightGrey constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const lightGrey + + + + + + + + +## Implementation + +```dart +static const Color lightGrey = Color(0xFFECECEC); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/overline.md b/talawa-mobile-docs/apptheme/AppTheme/overline.md new file mode 100644 index 0000000000..8e21f35cfb --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/overline.md @@ -0,0 +1,37 @@ + + + +# overline property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) overline + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle overline = const TextStyle( + fontSize: 6, + fontWeight: FontWeight.w400, + color: blackSecondary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md b/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md new file mode 100644 index 0000000000..038d130c59 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/primary-constant.md @@ -0,0 +1,32 @@ + + + +# primary constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const primary + + + + + + + + +## Implementation + +```dart +static const Color primary = Color(0xFFFFC107); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/red-constant.md b/talawa-mobile-docs/apptheme/AppTheme/red-constant.md new file mode 100644 index 0000000000..372e2ea7c2 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/red-constant.md @@ -0,0 +1,32 @@ + + + +# red constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const red + + + + + + + + +## Implementation + +```dart +static const Color red = Color(0xFFEB5757); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md b/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md new file mode 100644 index 0000000000..1f36d46c99 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/secondary-constant.md @@ -0,0 +1,32 @@ + + + +# secondary constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const secondary + + + + + + + + +## Implementation + +```dart +static const Color secondary = Color(0xFF795548); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md b/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md new file mode 100644 index 0000000000..28767a56f9 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/shadow-constant.md @@ -0,0 +1,32 @@ + + + +# shadow constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const shadow + + + + + + + + +## Implementation + +```dart +static const Color shadow = Color(0x408E8E8E); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md b/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md new file mode 100644 index 0000000000..7aa5a306db --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/subtitle1.md @@ -0,0 +1,37 @@ + + + +# subtitle1 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) subtitle1 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle subtitle1 = const TextStyle( + fontSize: 14, + fontWeight: FontWeight.w500, + color: blackSecondary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md b/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md new file mode 100644 index 0000000000..cb3d34fadc --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/subtitle2.md @@ -0,0 +1,37 @@ + + + +# subtitle2 property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) subtitle2 + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle subtitle2 = const TextStyle( + fontSize: 12, + fontWeight: FontWeight.w500, + color: blackSecondary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md b/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md new file mode 100644 index 0000000000..020d4a1c34 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/tertiary-constant.md @@ -0,0 +1,32 @@ + + + +# tertiary constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const tertiary + + + + + + + + +## Implementation + +```dart +static const Color tertiary = Color(0xFFA16938); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/title.md b/talawa-mobile-docs/apptheme/AppTheme/title.md new file mode 100644 index 0000000000..21377023fc --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/title.md @@ -0,0 +1,37 @@ + + + +# title property + + + + + + + +[TextStyle](https://api.flutter.dev/flutter/painting/TextStyle-class.html) title + +_read / write_ + + + + + + +## Implementation + +```dart +static TextStyle title = const TextStyle( + fontSize: 20, + fontWeight: FontWeight.w600, + color: blackPrimary, + fontFamily: 'OpenSans', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/white-constant.md b/talawa-mobile-docs/apptheme/AppTheme/white-constant.md new file mode 100644 index 0000000000..40ddf426ab --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/white-constant.md @@ -0,0 +1,32 @@ + + + +# white constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const white + + + + + + + + +## Implementation + +```dart +static const Color white = Color(0xFFFFFFFF); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md b/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md new file mode 100644 index 0000000000..19aedaf740 --- /dev/null +++ b/talawa-mobile-docs/apptheme/AppTheme/yellow-constant.md @@ -0,0 +1,32 @@ + + + +# yellow constant + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) const yellow + + + + + + + + +## Implementation + +```dart +static const Color yellow = Color(0xffF6BA18); +``` + + + + + + + diff --git a/talawa-mobile-docs/apptheme/apptheme-library.md b/talawa-mobile-docs/apptheme/apptheme-library.md new file mode 100644 index 0000000000..c5efcd9ed8 --- /dev/null +++ b/talawa-mobile-docs/apptheme/apptheme-library.md @@ -0,0 +1,38 @@ + + + + +# apptheme library + + + + + + + + + + + +## Classes + +##### [AppTheme](../apptheme/AppTheme-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/categories.json b/talawa-mobile-docs/categories.json new file mode 100644 index 0000000000..fe51488c70 --- /dev/null +++ b/talawa-mobile-docs/categories.json @@ -0,0 +1 @@ +[] diff --git a/talawa-mobile-docs/constants_constants/constants_constants-library.md b/talawa-mobile-docs/constants_constants/constants_constants-library.md new file mode 100644 index 0000000000..0281be84bb --- /dev/null +++ b/talawa-mobile-docs/constants_constants/constants_constants-library.md @@ -0,0 +1,49 @@ + + + + +# constants library + + + + + + + + + + + + + + + +## 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)> + + + +This file contains the prototypes of all the languages available and supported currencies. +_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)> + + + + +_read / write_ + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_constants/languages.md b/talawa-mobile-docs/constants_constants/languages.md new file mode 100644 index 0000000000..eb6fa823a8 --- /dev/null +++ b/talawa-mobile-docs/constants_constants/languages.md @@ -0,0 +1,85 @@ + + + +# languages top-level property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Language](../models_language_language_model/Language-class.md)> languages + +_read / write_ + + + +

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

+ + + +## Implementation + +```dart +List languages = [ + Language( + countryCode: 'US', + langCode: 'en', + langName: 'English', + langSample: 'Welcome User', + ), + Language( + countryCode: 'IN', + langCode: 'hi', + langName: 'हिंदी', + langSample: 'स्वागत उपयोगकर्ता', + ), + Language( + countryCode: 'CN', + langCode: 'zh', + langName: '中国人', + langSample: '欢迎用户', + ), + Language( + countryCode: 'FR', + langCode: 'fr', + langName: 'français', + langSample: 'Bienvenue utilisateur', + ), + Language( + countryCode: 'ES', + langCode: 'es', + langName: 'Española', + langSample: 'Bienvenida usuario', + ), + Language( + countryCode: 'JP', + langCode: 'ja', + langName: '日本', + langSample: 'ようこそユーザー', + ), + Language( + countryCode: 'GE', + langCode: 'de', + langName: 'Deutsch', + langSample: 'Willkommen Benutzer', + ), + Language( + countryCode: 'PE', + langCode: 'pt', + langName: 'português', + langSample: 'Bem-vindo, usuário', + ), +]; +``` + + + + + + + + diff --git a/talawa-mobile-docs/constants_constants/supportedCurrencies.md b/talawa-mobile-docs/constants_constants/supportedCurrencies.md new file mode 100644 index 0000000000..74339c2244 --- /dev/null +++ b/talawa-mobile-docs/constants_constants/supportedCurrencies.md @@ -0,0 +1,129 @@ + + + +# supportedCurrencies top-level property + + + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +List supportedCurrencies = [ + 'AED', + 'ALL', + 'AMD', + 'ARS', + 'AUD', + 'AWG', + 'BBD', + 'BDT', + 'BMD', + 'BND', + 'BOB', + 'BSD', + 'BWP', + 'BZD', + 'CAD', + 'CHF', + 'CNY', + 'COP', + 'CRC', + 'CUP', + 'CZK', + 'DKK', + 'DOP', + 'DZD', + 'EGP', + 'ETB', + 'EUR', + 'FJD', + 'GBP', + 'GHS', + 'GIP', + 'GMD', + 'GTQ', + 'GYD', + 'HKD', + 'HNL', + 'HRK', + 'HTG', + 'HUF', + 'IDR', + 'ILS', + 'INR', + 'JMD', + 'KES', + 'KGS', + 'KHR', + 'KYD', + 'KZT', + 'LAK', + 'LBP', + 'LKR', + 'LRD', + 'LSL', + 'MAD', + 'MDL', + 'MKD', + 'MMK', + 'MNT', + 'MOP', + 'MUR', + 'MVR', + 'MWK', + 'MXN', + 'MYR', + 'NAD', + 'NGN', + 'NIO', + 'NOK', + 'NPR', + 'NZD', + 'PEN', + 'PGK', + 'PHP', + 'PKR', + 'QAR', + 'RUB', + 'SAR', + 'SCR', + 'SEK', + 'SGD', + 'SLL', + 'SOS', + 'SSP', + 'SVC', + 'SZL', + 'THB', + 'TTD', + 'TZS', + 'USD', + 'UYU', + 'UZS', + 'YER', + 'ZAR', +]; +``` + + + + + + + + diff --git a/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md b/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md new file mode 100644 index 0000000000..256b879933 --- /dev/null +++ b/talawa-mobile-docs/constants_custom_theme/TalawaTheme-class.md @@ -0,0 +1,114 @@ + + + +# TalawaTheme class + + + + + + + + + +

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.

+ + + + +## Constructors + +[TalawaTheme](../constants_custom_theme/TalawaTheme/TalawaTheme.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + +## Static Properties + +##### [darkTheme](../constants_custom_theme/TalawaTheme/darkTheme.md) → [ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) + + + + +_final_ + + + +##### [lightTheme](../constants_custom_theme/TalawaTheme/lightTheme.md) → [ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) + + + + +_final_ + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_custom_theme/TalawaTheme/TalawaTheme.md b/talawa-mobile-docs/constants_custom_theme/TalawaTheme/TalawaTheme.md new file mode 100644 index 0000000000..6e0ab5ca74 --- /dev/null +++ b/talawa-mobile-docs/constants_custom_theme/TalawaTheme/TalawaTheme.md @@ -0,0 +1,24 @@ + + + +# TalawaTheme constructor + + + + + + + +TalawaTheme() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md b/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md new file mode 100644 index 0000000000..dba6e0b108 --- /dev/null +++ b/talawa-mobile-docs/constants_custom_theme/TalawaTheme/darkTheme.md @@ -0,0 +1,50 @@ + + + +# darkTheme property + + + + + + + +[ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) darkTheme + +_final_ + + + + + + +## Implementation + +```dart +static final darkTheme = ThemeData( + textSelectionTheme: const TextSelectionThemeData( + cursorColor: _darkCursorColor, + ), + scaffoldBackgroundColor: _darkScaffoldColor, + primaryColor: _darkPrimaryColor, + iconTheme: const IconThemeData( + color: _darkIconColor, + ), + fontFamily: 'product-sans', + textTheme: _darkTextTheme, + inputDecorationTheme: _darkInputDecor, + colorScheme: const ColorScheme.dark( + primaryContainer: _darkPrimaryVariantColor, + primary: _darkColorSchemePrimary, + secondary: Colors.black, + secondaryContainer: _lightScaffoldColor, + ).copyWith(secondary: _darkAccentColor), +); +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md b/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md new file mode 100644 index 0000000000..e47787d498 --- /dev/null +++ b/talawa-mobile-docs/constants_custom_theme/TalawaTheme/lightTheme.md @@ -0,0 +1,50 @@ + + + +# lightTheme property + + + + + + + +[ThemeData](https://api.flutter.dev/flutter/material/ThemeData-class.html) lightTheme + +_final_ + + + + + + +## Implementation + +```dart +static final lightTheme = ThemeData( + scaffoldBackgroundColor: _lightScaffoldColor, + textSelectionTheme: const TextSelectionThemeData( + cursorColor: _lightCursorColor, + ), + primaryColor: _lightPrimaryColor, + iconTheme: const IconThemeData( + color: _lightIconColor, + ), + fontFamily: 'product-sans', + textTheme: _lightTextTheme, + inputDecorationTheme: _lightInputDecor, + colorScheme: const ColorScheme.light( + primaryContainer: _lightPrimaryVariantColor, + primary: _lightColorSchemePrimary, + secondary: Color(0xffF5F5F5), + secondaryContainer: _darkScaffoldColor, + ).copyWith(secondary: _lightAccentColor), +); +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_custom_theme/constants_custom_theme-library.md b/talawa-mobile-docs/constants_custom_theme/constants_custom_theme-library.md new file mode 100644 index 0000000000..6c16bab5ea --- /dev/null +++ b/talawa-mobile-docs/constants_custom_theme/constants_custom_theme-library.md @@ -0,0 +1,40 @@ + + + + +# custom_theme library + + + + + + + + + + + +## Classes + +##### [TalawaTheme](../constants_custom_theme/TalawaTheme-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md new file mode 100644 index 0000000000..b573a68b76 --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu-class.md @@ -0,0 +1,133 @@ + + + +# ShortCutMenu class + + + + + + + + + +

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

+ + + + +## Constructors + +[ShortCutMenu](../constants_quick_actions/ShortCutMenu/ShortCutMenu.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + + +_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) + + + + + + + + +##### [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) + + + + + + + + +##### [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/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/ShortCutMenu.md b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/ShortCutMenu.md new file mode 100644 index 0000000000..68d13d357d --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/ShortCutMenu.md @@ -0,0 +1,24 @@ + + + +# ShortCutMenu constructor + + + + + + + +ShortCutMenu() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md new file mode 100644 index 0000000000..2ae5a95069 --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/chatAction-constant.md @@ -0,0 +1,36 @@ + + + +# chatAction constant + + + + + + + +[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const chatAction + + + + + + + + +## Implementation + +```dart +static const chatAction = ShortcutItem( + type: "chat_action", + localizedTitle: "Messages", + icon: "chat_icon", +); +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md new file mode 100644 index 0000000000..a01744fc61 --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/eventAction-constant.md @@ -0,0 +1,36 @@ + + + +# eventAction constant + + + + + + + +[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const eventAction + + + + + + + + +## Implementation + +```dart +static const eventAction = ShortcutItem( + type: "events_action", + localizedTitle: "Events", + icon: "event_icon", +); +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md new file mode 100644 index 0000000000..e0417a7afa --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/feedAction-constant.md @@ -0,0 +1,36 @@ + + + +# feedAction constant + + + + + + + +[ShortcutItem](https://pub.dev/documentation/quick_actions_platform_interface/1.0.4/types_types/ShortcutItem-class.html) const feedAction + + + + + + + + +## Implementation + +```dart +static const feedAction = ShortcutItem( + type: "feed_action", + localizedTitle: "NewsFeed", + icon: "newsfeed_icon", +); +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md new file mode 100644 index 0000000000..bc88489487 --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/ShortCutMenu/quickActionsList.md @@ -0,0 +1,36 @@ + + + +# quickActionsList property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +static final quickActionsList = [ + eventAction, + feedAction, + chatAction +]; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_quick_actions/constants_quick_actions-library.md b/talawa-mobile-docs/constants_quick_actions/constants_quick_actions-library.md new file mode 100644 index 0000000000..edab8824a5 --- /dev/null +++ b/talawa-mobile-docs/constants_quick_actions/constants_quick_actions-library.md @@ -0,0 +1,39 @@ + + + + +# quick_actions library + + + + + + + + + + + +## Classes + +##### [ShortCutMenu](../constants_quick_actions/ShortCutMenu-class.md) + + + +This file contains the shortcuts by which user can manage and interact with the +application. quick_actions package is used for this purpose. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes-class.md b/talawa-mobile-docs/constants_routing_constants/Routes-class.md new file mode 100644 index 0000000000..50814616d7 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes-class.md @@ -0,0 +1,382 @@ + + + +# Routes class + + + + + + + + + +

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

+ + + + +## Constructors + +[Routes](../constants_routing_constants/Routes/Routes.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + +## Constants + +##### [addTask](../constants_routing_constants/Routes/addTask-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [appSettings](../constants_routing_constants/Routes/appSettings-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [calendar](../constants_routing_constants/Routes/calendar-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [chatMessageScreen](../constants_routing_constants/Routes/chatMessageScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [createEventPage](../constants_routing_constants/Routes/createEventPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [demoPageViewRoute](../constants_routing_constants/Routes/demoPageViewRoute-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [editEventPage](../constants_routing_constants/Routes/editEventPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [editProfilePage](../constants_routing_constants/Routes/editProfilePage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [editTask](../constants_routing_constants/Routes/editTask-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [eventInfoPage](../constants_routing_constants/Routes/eventInfoPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [eventTasks](../constants_routing_constants/Routes/eventTasks-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [exploreEventsScreen](../constants_routing_constants/Routes/exploreEventsScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [homeScreen](../constants_routing_constants/Routes/homeScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [individualPost](../constants_routing_constants/Routes/individualPost-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [joinOrg](../constants_routing_constants/Routes/joinOrg-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [languageSelectionRoute](../constants_routing_constants/Routes/languageSelectionRoute-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [loginScreen](../constants_routing_constants/Routes/loginScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [mainScreen](../constants_routing_constants/Routes/mainScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [mapScreen](../constants_routing_constants/Routes/mapScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [pinnedPostPage](../constants_routing_constants/Routes/pinnedPostPage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [profilePage](../constants_routing_constants/Routes/profilePage-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [progressDialog](../constants_routing_constants/Routes/progressDialog-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [recoverScreen](../constants_routing_constants/Routes/recoverScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [requestAccess](../constants_routing_constants/Routes/requestAccess-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [selectContact](../constants_routing_constants/Routes/selectContact-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [selectOrgScreen](../constants_routing_constants/Routes/selectOrgScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [setUrlScreen](../constants_routing_constants/Routes/setUrlScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [signupDetailScreen](../constants_routing_constants/Routes/signupDetailScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [splashScreen](../constants_routing_constants/Routes/splashScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [updateScreen](../constants_routing_constants/Routes/updateScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [userTasks](../constants_routing_constants/Routes/userTasks-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + +##### [waitingScreen](../constants_routing_constants/Routes/waitingScreen-constant.md) const [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +static variables. + + + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/Routes.md b/talawa-mobile-docs/constants_routing_constants/Routes/Routes.md new file mode 100644 index 0000000000..94fcce69ff --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/Routes.md @@ -0,0 +1,24 @@ + + + +# Routes constructor + + + + + + + +Routes() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md new file mode 100644 index 0000000000..7691308154 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/addTask-constant.md @@ -0,0 +1,33 @@ + + + +# addTask constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const addTask + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String addTask = '/addTask'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md new file mode 100644 index 0000000000..055c9cc619 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/appSettings-constant.md @@ -0,0 +1,33 @@ + + + +# appSettings constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const appSettings + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String appSettings = '/appSettingsPage'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md new file mode 100644 index 0000000000..e68f3aef8e --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/calendar-constant.md @@ -0,0 +1,33 @@ + + + +# calendar constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const calendar + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String calendar = '/calendar'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md new file mode 100644 index 0000000000..143ffb1c3f --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/chatMessageScreen-constant.md @@ -0,0 +1,33 @@ + + + +# chatMessageScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const chatMessageScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String chatMessageScreen = '/chatMessageScreen'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md new file mode 100644 index 0000000000..cbc75f3c32 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/createEventPage-constant.md @@ -0,0 +1,33 @@ + + + +# createEventPage constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const createEventPage + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String createEventPage = "/createEventPage"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md new file mode 100644 index 0000000000..4872c8cc56 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/demoPageViewRoute-constant.md @@ -0,0 +1,33 @@ + + + +# demoPageViewRoute constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const demoPageViewRoute + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String demoPageViewRoute = "/demoPageViewRoute"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md new file mode 100644 index 0000000000..37189f5363 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/editEventPage-constant.md @@ -0,0 +1,33 @@ + + + +# editEventPage constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const editEventPage + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String editEventPage = "/editEventPage"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md new file mode 100644 index 0000000000..eeb2fae246 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/editProfilePage-constant.md @@ -0,0 +1,33 @@ + + + +# editProfilePage constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const editProfilePage + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String editProfilePage = "/editProfilePage"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md new file mode 100644 index 0000000000..8dce26712c --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/editTask-constant.md @@ -0,0 +1,33 @@ + + + +# editTask constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const editTask + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String editTask = '/editTask'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md new file mode 100644 index 0000000000..d40a818cc5 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/eventInfoPage-constant.md @@ -0,0 +1,33 @@ + + + +# eventInfoPage constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const eventInfoPage + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String eventInfoPage = "/eventInfo"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md new file mode 100644 index 0000000000..5f1ae45659 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/eventTasks-constant.md @@ -0,0 +1,33 @@ + + + +# eventTasks constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const eventTasks + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String eventTasks = '/event_tasks'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md new file mode 100644 index 0000000000..49d7f4b781 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/exploreEventsScreen-constant.md @@ -0,0 +1,33 @@ + + + +# exploreEventsScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const exploreEventsScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String exploreEventsScreen = "/exploreEvents"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md new file mode 100644 index 0000000000..2e5038d9be --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/homeScreen-constant.md @@ -0,0 +1,33 @@ + + + +# homeScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const homeScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String homeScreen = "/homeScreen"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md new file mode 100644 index 0000000000..8e90b10afb --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/individualPost-constant.md @@ -0,0 +1,33 @@ + + + +# individualPost constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const individualPost + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String individualPost = "/individualPost"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md new file mode 100644 index 0000000000..b15ae14431 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/joinOrg-constant.md @@ -0,0 +1,33 @@ + + + +# joinOrg constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const joinOrg + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String joinOrg = '/joinOrg'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md new file mode 100644 index 0000000000..c44d80fa2f --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/languageSelectionRoute-constant.md @@ -0,0 +1,33 @@ + + + +# languageSelectionRoute constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const languageSelectionRoute + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String languageSelectionRoute = "/selectLang"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md new file mode 100644 index 0000000000..8fec21cdf1 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/loginScreen-constant.md @@ -0,0 +1,33 @@ + + + +# loginScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const loginScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String loginScreen = "/login"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md new file mode 100644 index 0000000000..ea0792a531 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/mainScreen-constant.md @@ -0,0 +1,33 @@ + + + +# mainScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const mainScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String mainScreen = "/mainScreen"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md new file mode 100644 index 0000000000..b4e93a646d --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/mapScreen-constant.md @@ -0,0 +1,33 @@ + + + +# mapScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const mapScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String mapScreen = '/mapScreen'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md new file mode 100644 index 0000000000..c818d6e26d --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/pinnedPostPage-constant.md @@ -0,0 +1,33 @@ + + + +# pinnedPostPage constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const pinnedPostPage + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String pinnedPostPage = "/pinnedPostPage"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md new file mode 100644 index 0000000000..c81e48b568 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/profilePage-constant.md @@ -0,0 +1,33 @@ + + + +# profilePage constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const profilePage + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String profilePage = "/profilePage"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md new file mode 100644 index 0000000000..9b8fc0437a --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/progressDialog-constant.md @@ -0,0 +1,33 @@ + + + +# progressDialog constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const progressDialog + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String progressDialog = "/progress"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md new file mode 100644 index 0000000000..ec709fd387 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/recoverScreen-constant.md @@ -0,0 +1,33 @@ + + + +# recoverScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const recoverScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String recoverScreen = "/recover"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md new file mode 100644 index 0000000000..1107d1e0b9 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/requestAccess-constant.md @@ -0,0 +1,33 @@ + + + +# requestAccess constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const requestAccess + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String requestAccess = '/requestAccess'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md new file mode 100644 index 0000000000..7f8f9c69ec --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/selectContact-constant.md @@ -0,0 +1,33 @@ + + + +# selectContact constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const selectContact + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String selectContact = '/selectContact'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md new file mode 100644 index 0000000000..23c3b5949a --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/selectOrgScreen-constant.md @@ -0,0 +1,33 @@ + + + +# selectOrgScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const selectOrgScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String selectOrgScreen = "/selectOrg"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md new file mode 100644 index 0000000000..e3231e3acd --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/setUrlScreen-constant.md @@ -0,0 +1,33 @@ + + + +# setUrlScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const setUrlScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String setUrlScreen = "/setUrl"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md new file mode 100644 index 0000000000..1d2c874671 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/signupDetailScreen-constant.md @@ -0,0 +1,33 @@ + + + +# signupDetailScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const signupDetailScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String signupDetailScreen = "/signupDetails"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md new file mode 100644 index 0000000000..b2fdcfbfad --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/splashScreen-constant.md @@ -0,0 +1,33 @@ + + + +# splashScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const splashScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String splashScreen = "/"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md new file mode 100644 index 0000000000..5264a460fb --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/updateScreen-constant.md @@ -0,0 +1,33 @@ + + + +# updateScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const updateScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String updateScreen = "/update"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md new file mode 100644 index 0000000000..13241dbafb --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/userTasks-constant.md @@ -0,0 +1,33 @@ + + + +# userTasks constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const userTasks + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String userTasks = '/user_tasks'; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md b/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md new file mode 100644 index 0000000000..14dea52eb6 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/Routes/waitingScreen-constant.md @@ -0,0 +1,33 @@ + + + +# waitingScreen constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const waitingScreen + + + + + +

static variables.

+ + + +## Implementation + +```dart +static const String waitingScreen = "/waiting"; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_routing_constants/constants_routing_constants-library.md b/talawa-mobile-docs/constants_routing_constants/constants_routing_constants-library.md new file mode 100644 index 0000000000..f0958e2722 --- /dev/null +++ b/talawa-mobile-docs/constants_routing_constants/constants_routing_constants-library.md @@ -0,0 +1,38 @@ + + + + +# routing_constants library + + + + + + + + + + + +## Classes + +##### [Routes](../constants_routing_constants/Routes-class.md) + + + +This file contains the routes. These can be used to make push screen call via Routes.splashScreen to access these string. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_timeout/TimeOuts-class.md b/talawa-mobile-docs/constants_timeout/TimeOuts-class.md new file mode 100644 index 0000000000..b85d9801ee --- /dev/null +++ b/talawa-mobile-docs/constants_timeout/TimeOuts-class.md @@ -0,0 +1,121 @@ + + + +# TimeOuts class + + + + + + + + + +

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

+ + + + +## Constructors + +[TimeOuts](../constants_timeout/TimeOuts/TimeOuts.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + +## Constants + +##### [large](../constants_timeout/TimeOuts/large-constant.md) const [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + +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) + + + +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) + + + +For small timeout, used for small data fetch. + + + + + + + + + diff --git a/talawa-mobile-docs/constants_timeout/TimeOuts/TimeOuts.md b/talawa-mobile-docs/constants_timeout/TimeOuts/TimeOuts.md new file mode 100644 index 0000000000..75d16c8cb5 --- /dev/null +++ b/talawa-mobile-docs/constants_timeout/TimeOuts/TimeOuts.md @@ -0,0 +1,24 @@ + + + +# TimeOuts constructor + + + + + + + +TimeOuts() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md b/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md new file mode 100644 index 0000000000..06ea1ae785 --- /dev/null +++ b/talawa-mobile-docs/constants_timeout/TimeOuts/large-constant.md @@ -0,0 +1,33 @@ + + + +# large constant + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) const large + + + + + +

For large timeout, used for large data fetch.

+ + + +## Implementation + +```dart +static const large = 300; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md b/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md new file mode 100644 index 0000000000..c481d6b877 --- /dev/null +++ b/talawa-mobile-docs/constants_timeout/TimeOuts/mediums-constant.md @@ -0,0 +1,33 @@ + + + +# mediums constant + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) const mediums + + + + + +

For medium timeout, used for medium data fetch.

+ + + +## Implementation + +```dart +static const mediums = 100; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md b/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md new file mode 100644 index 0000000000..3fce2b6068 --- /dev/null +++ b/talawa-mobile-docs/constants_timeout/TimeOuts/small-constant.md @@ -0,0 +1,33 @@ + + + +# small constant + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) const small + + + + + +

For small timeout, used for small data fetch.

+ + + +## Implementation + +```dart +static const small = 5; +``` + + + + + + + diff --git a/talawa-mobile-docs/constants_timeout/constants_timeout-library.md b/talawa-mobile-docs/constants_timeout/constants_timeout-library.md new file mode 100644 index 0000000000..68fa606656 --- /dev/null +++ b/talawa-mobile-docs/constants_timeout/constants_timeout-library.md @@ -0,0 +1,38 @@ + + + + +# timeout library + + + + + + + + + + + +## Classes + +##### [TimeOuts](../constants_timeout/TimeOuts-class.md) + + + +Class to define constant timeout to bring consistency in the code. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md new file mode 100644 index 0000000000..a05ca02ba1 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon-class.md @@ -0,0 +1,183 @@ + + + +# LanguageIcon class + + + + + + + + + +

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.

+ + + +**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) +- LanguageIcon + + + + + + + + +## Constructors + +[LanguageIcon](../custom_painters_language_icon/LanguageIcon/LanguageIcon.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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 +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_ + + + +##### [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_ + + + +##### [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 +delegate class (which amounts to the same thing, because the latter is +implemented in terms of the former). +_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) + + + +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). +_override_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/LanguageIcon.md b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/LanguageIcon.md new file mode 100644 index 0000000000..65d824c574 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/LanguageIcon.md @@ -0,0 +1,24 @@ + + + +# LanguageIcon constructor + + + + + + + +LanguageIcon() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md new file mode 100644 index 0000000000..ef9042c71c --- /dev/null +++ b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/paint.md @@ -0,0 +1,382 @@ + + + +# paint method + + + + + + + +- @[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) + +_override_ + + + +

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 +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 +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. +
+ + + +## Implementation + +```dart +@override +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( + size.width * 0.2321886, + size.height * 0.4003127, + size.width * 0.2254689, + size.height * 0.3343750, + size.width * 0.2254689, + size.height * 0.3343750, + ); + path_0.lineTo(size.width * 0.2246875, size.height * 0.3343750); + path_0.cubicTo( + size.width * 0.2246875, + size.height * 0.3343750, + size.width * 0.2179686, + size.height * 0.4003127, + size.width * 0.2125000, + size.height * 0.4381250, + ); + path_0.lineTo(size.width * 0.1951561, size.height * 0.5553136); + path_0.lineTo(size.width * 0.2546886, size.height * 0.5553136); + path_0.lineTo(size.width * 0.2376568, size.height * 0.4381250); + path_0.close(); + path_0.moveTo(size.width * 0.9625000, 0); + path_0.lineTo(size.width * 0.5250000, 0); + path_0.lineTo(size.width * 0.5250000, size.height); + path_0.lineTo(size.width * 0.9625000, size.height); + path_0.cubicTo( + size.width * 0.9832818, + size.height, + size.width, + size.height * 0.9665636, + size.width, + size.height * 0.9250000, + ); + path_0.lineTo(size.width, size.height * 0.07500000); + path_0.cubicTo( + size.width, + size.height * 0.03343750, + size.width * 0.9832818, + 0, + size.width * 0.9625000, + 0, + ); + path_0.close(); + path_0.moveTo(size.width * 0.9250000, size.height * 0.3750000); + path_0.cubicTo( + size.width * 0.9250000, + size.height * 0.3956250, + size.width * 0.9165636, + size.height * 0.4125000, + size.width * 0.9062500, + size.height * 0.4125000, + ); + path_0.lineTo(size.width * 0.8884364, size.height * 0.4125000); + path_0.cubicTo( + size.width * 0.8776568, + size.height * 0.4862500, + size.width * 0.8545318, + size.height * 0.5606227, + size.width * 0.8217182, + size.height * 0.6309364, + ); + path_0.cubicTo( + size.width * 0.8348432, + size.height * 0.6509364, + size.width * 0.8484364, + size.height * 0.6700000, + size.width * 0.8625000, + size.height * 0.6871864, + ); + path_0.cubicTo( + size.width * 0.8710932, + size.height * 0.6978136, + size.width * 0.8739068, + size.height * 0.7200000, + size.width * 0.8689068, + size.height * 0.7378136, + ); + path_0.lineTo(size.width * 0.8565636, size.height * 0.7812500); + path_0.cubicTo( + size.width * 0.8512500, + size.height * 0.7996864, + size.width * 0.8395318, + size.height * 0.8056227, + size.width * 0.8304682, + size.height * 0.7946864, + ); + path_0.cubicTo( + size.width * 0.8107818, + size.height * 0.7703136, + size.width * 0.7921886, + size.height * 0.7443727, + size.width * 0.7751568, + size.height * 0.7168727, + ); + path_0.cubicTo( + size.width * 0.7581250, + size.height * 0.7440636, + size.width * 0.7396886, + size.height * 0.7703136, + size.width * 0.7198432, + size.height * 0.7946864, + ); + path_0.cubicTo( + size.width * 0.7107818, + size.height * 0.8056227, + size.width * 0.6990636, + size.height * 0.7996864, + size.width * 0.6937500, + size.height * 0.7812500, + ); + path_0.lineTo(size.width * 0.6814068, size.height * 0.7378136); + path_0.cubicTo( + size.width * 0.6764068, + size.height * 0.7203136, + size.width * 0.6792182, + size.height * 0.6978136, + size.width * 0.6879682, + size.height * 0.6871864, + ); + path_0.cubicTo( + size.width * 0.7025000, + size.height * 0.6693727, + size.width * 0.7160932, + size.height * 0.6506273, + size.width * 0.7287500, + size.height * 0.6309364, + ); + path_0.cubicTo( + size.width * 0.7164068, + size.height * 0.6046864, + size.width * 0.7054682, + size.height * 0.5778136, + size.width * 0.6959386, + size.height * 0.5506273, + ); + path_0.cubicTo( + size.width * 0.6896886, + size.height * 0.5328136, + size.width * 0.6925000, + size.height * 0.5081273, + size.width * 0.7017182, + size.height * 0.4971864, + ); + path_0.lineTo(size.width * 0.7118750, size.height * 0.4850000); + path_0.lineTo(size.width * 0.7232818, size.height * 0.4715636); + path_0.cubicTo( + size.width * 0.7317182, + size.height * 0.4615636, + size.width * 0.7426568, + size.height * 0.4662500, + size.width * 0.7482818, + size.height * 0.4821864, + ); + path_0.cubicTo( + size.width * 0.7560932, + size.height * 0.5040636, + size.width * 0.7651568, + size.height * 0.5259364, + size.width * 0.7754682, + size.height * 0.5475000, + ); + path_0.cubicTo( + size.width * 0.7965614, + size.height * 0.5031273, + size.width * 0.8126568, + size.height * 0.4571864, + size.width * 0.8223432, + size.height * 0.4125000, + ); + path_0.lineTo(size.width * 0.6437500, size.height * 0.4125000); + path_0.cubicTo( + size.width * 0.6334386, + size.height * 0.4125000, + size.width * 0.6250000, + size.height * 0.3956250, + size.width * 0.6250000, + size.height * 0.3750000, + ); + path_0.lineTo(size.width * 0.6250000, size.height * 0.3250000); + path_0.cubicTo( + size.width * 0.6250000, + size.height * 0.3043750, + size.width * 0.6334386, + size.height * 0.2875000, + size.width * 0.6437500, + size.height * 0.2875000, + ); + path_0.lineTo(size.width * 0.7437500, size.height * 0.2875000); + path_0.lineTo(size.width * 0.7437500, size.height * 0.2375000); + path_0.cubicTo( + size.width * 0.7437500, + size.height * 0.2168750, + size.width * 0.7521886, + size.height * 0.2000000, + size.width * 0.7625000, + size.height * 0.2000000, + ); + path_0.lineTo(size.width * 0.7875000, size.height * 0.2000000); + path_0.cubicTo( + size.width * 0.7978136, + size.height * 0.2000000, + size.width * 0.8062500, + size.height * 0.2168750, + size.width * 0.8062500, + size.height * 0.2375000, + ); + path_0.lineTo(size.width * 0.8062500, size.height * 0.2875000); + path_0.lineTo(size.width * 0.9062500, size.height * 0.2875000); + path_0.cubicTo( + size.width * 0.9165636, + size.height * 0.2875000, + size.width * 0.9250000, + size.height * 0.3043750, + size.width * 0.9250000, + size.height * 0.3250000, + ); + path_0.lineTo(size.width * 0.9250000, size.height * 0.3750000); + path_0.close(); + path_0.moveTo(0, size.height * 0.07500000); + path_0.lineTo(0, size.height * 0.9250000); + path_0.cubicTo( + 0, + size.height * 0.9665636, + size.width * 0.01671875, + size.height, + size.width * 0.03750000, + size.height, + ); + path_0.lineTo(size.width * 0.4750000, size.height); + path_0.lineTo(size.width * 0.4750000, 0); + path_0.lineTo(size.width * 0.03750000, 0); + path_0.cubicTo( + size.width * 0.01671875, + 0, + 0, + size.height * 0.03343750, + 0, + size.height * 0.07500000, + ); + path_0.close(); + path_0.moveTo(size.width * 0.09203136, size.height * 0.7503136); + path_0.lineTo(size.width * 0.1818750, size.height * 0.2218750); + path_0.cubicTo( + size.width * 0.1845314, + size.height * 0.2065623, + size.width * 0.1915625, + size.height * 0.1965623, + size.width * 0.1996875, + size.height * 0.1965623, + ); + path_0.lineTo(size.width * 0.2504682, size.height * 0.1965623); + path_0.cubicTo( + size.width * 0.2584386, + size.height * 0.1965623, + size.width * 0.2656250, + size.height * 0.2068750, + size.width * 0.2682818, + size.height * 0.2218750, + ); + path_0.lineTo(size.width * 0.3581250, size.height * 0.7503136); + path_0.cubicTo( + size.width * 0.3621864, + size.height * 0.7746864, + size.width * 0.3532818, + size.height * 0.8000000, + size.width * 0.3403136, + size.height * 0.8000000, + ); + path_0.lineTo(size.width * 0.3045318, size.height * 0.8000000); + path_0.cubicTo( + size.width * 0.3004886, + size.height * 0.7999955, + size.width * 0.2965523, + size.height * 0.7973727, + size.width * 0.2933159, + size.height * 0.7925318, + ); + path_0.cubicTo( + size.width * 0.2900773, + size.height * 0.7876864, + size.width * 0.2877091, + size.height * 0.7808818, + size.width * 0.2865614, + size.height * 0.7731227, + ); + path_0.lineTo(size.width * 0.2718750, size.height * 0.6734364); + path_0.lineTo(size.width * 0.1778125, size.height * 0.6734364); + path_0.lineTo(size.width * 0.1635936, size.height * 0.7728136); + path_0.cubicTo( + size.width * 0.1612500, + size.height * 0.7887500, + size.width * 0.1539061, + size.height * 0.8000000, + size.width * 0.1456250, + size.height * 0.8000000, + ); + path_0.lineTo(size.width * 0.1098439, size.height * 0.8000000); + path_0.cubicTo( + size.width * 0.09703136, + size.height * 0.8000000, + size.width * 0.08796886, + size.height * 0.7746864, + size.width * 0.09203136, + size.height * 0.7503136, + ); + path_0.close(); + + final Paint paint0fill = Paint()..style = PaintingStyle.fill; + paint0fill.color = const Color(0xff737373).withOpacity(1.0); + canvas.drawPath(path_0, paint0fill); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md new file mode 100644 index 0000000000..a74a9cec45 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_language_icon/LanguageIcon/shouldRepaint.md @@ -0,0 +1,58 @@ + + + +# shouldRepaint method + + + + + + + +- @[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) + +_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 +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 +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.

+ + + +## Implementation + +```dart +@override +bool shouldRepaint(covariant CustomPainter oldDelegate) { + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_language_icon/custom_painters_language_icon-library.md b/talawa-mobile-docs/custom_painters_language_icon/custom_painters_language_icon-library.md new file mode 100644 index 0000000000..f987bcce85 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_language_icon/custom_painters_language_icon-library.md @@ -0,0 +1,40 @@ + + + + +# language_icon library + + + + + + + + + + + +## Classes + +##### [LanguageIcon](../custom_painters_language_icon/LanguageIcon-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo-class.md b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo-class.md new file mode 100644 index 0000000000..baaa311d69 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo-class.md @@ -0,0 +1,183 @@ + + + +# AppLogo class + + + + + + + + + +

This class draws the app logo using custom paint. +CustomPaint is a widget from the Flutter SDK, which enables +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) +- AppLogo + + + + + + + + +## Constructors + +[AppLogo](../custom_painters_talawa_logo/AppLogo/AppLogo.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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 +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_ + + + +##### [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_ + + + +##### [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 +delegate class (which amounts to the same thing, because the latter is +implemented in terms of the former). +_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) + + + +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). +_override_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/AppLogo.md b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/AppLogo.md new file mode 100644 index 0000000000..8dad793f78 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/AppLogo.md @@ -0,0 +1,24 @@ + + + +# AppLogo constructor + + + + + + + +AppLogo() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md new file mode 100644 index 0000000000..0dc5d60562 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/paint.md @@ -0,0 +1,485 @@ + + + +# paint method + + + + + + + +- @[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) + +_override_ + + + +

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 +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 +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. +
+ + + +## Implementation + +```dart +@override +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( + size.width * 0.6951984, + size.height * 0.6792024, + size.width * 0.7321984, + size.height * 0.7386032, + size.width * 0.7695992, + size.height * 0.7978016, + ); + path_0.cubicTo( + size.width * 0.7737976, + size.height * 0.8044008, + size.width * 0.7730000, + size.height * 0.8070040, + size.width * 0.7664008, + size.height * 0.8112024, + ); + path_0.cubicTo( + size.width * 0.7314008, + size.height * 0.8330040, + size.width * 0.6964008, + size.height * 0.8552024, + size.width * 0.6617976, + size.height * 0.8776032, + ); + path_0.cubicTo( + size.width * 0.6560000, + size.height * 0.8814008, + size.width * 0.6534008, + size.height * 0.8820040, + size.width * 0.6491984, + size.height * 0.8750040, + ); + path_0.cubicTo( + size.width * 0.5995992, + size.height * 0.7930040, + size.width * 0.5495992, + size.height * 0.7112024, + size.width * 0.4997976, + size.height * 0.6292024, + ); + path_0.cubicTo( + size.width * 0.4941984, + size.height * 0.6198016, + size.width * 0.4940000, + size.height * 0.6200040, + size.width * 0.4884008, + size.height * 0.6292024, + ); + path_0.cubicTo( + size.width * 0.4380000, + size.height * 0.7114008, + size.width * 0.3873992, + size.height * 0.7938016, + size.width * 0.3371992, + size.height * 0.8762024, + ); + path_0.cubicTo( + size.width * 0.3337992, + size.height * 0.8818016, + size.width * 0.3317992, + size.height * 0.8816032, + size.width * 0.3267992, + size.height * 0.8784008, + ); + path_0.cubicTo( + size.width * 0.2913992, + size.height * 0.8558016, + size.width * 0.2559992, + size.height * 0.8334008, + size.width * 0.2203992, + size.height * 0.8112024, + ); + path_0.cubicTo( + size.width * 0.2165992, + size.height * 0.8088016, + size.width * 0.2131992, + size.height * 0.8076032, + size.width * 0.2167992, + size.height * 0.8018016, + ); + path_0.cubicTo( + size.width * 0.2547992, + size.height * 0.7420040, + size.width * 0.2923992, + size.height * 0.6818016, + size.width * 0.3301992, + size.height * 0.6218016, + ); + path_0.cubicTo( + size.width * 0.3575992, + size.height * 0.5766032, + size.width * 0.3853992, + size.height * 0.5320040, + size.width * 0.4130000, + size.height * 0.4870040, + ); + path_0.cubicTo( + size.width * 0.4191984, + size.height * 0.4768016, + size.width * 0.4255992, + size.height * 0.4666032, + size.width * 0.4317976, + size.height * 0.4564008, + ); + path_0.cubicTo( + size.width * 0.4347976, + size.height * 0.4516032, + size.width * 0.4377976, + size.height * 0.4468016, + size.width * 0.4441984, + size.height * 0.4458016, + ); + path_0.cubicTo( + size.width * 0.4541984, + size.height * 0.4452024, + size.width * 0.4640000, + size.height * 0.4472024, + size.width * 0.4740000, + size.height * 0.4474008, + ); + path_0.cubicTo( + size.width * 0.4960000, + size.height * 0.4482024, + size.width * 0.5167976, + size.height * 0.4438016, + size.width * 0.5377976, + size.height * 0.4382024, + ); + path_0.cubicTo( + size.width * 0.5435992, + size.height * 0.4374008, + size.width * 0.5470000, + size.height * 0.4408016, + size.width * 0.5497976, + size.height * 0.4454008, + ); + path_0.cubicTo( + size.width * 0.5830000, + size.height * 0.5002024, + size.width * 0.6170000, + size.height * 0.5546032, + size.width * 0.6497976, + size.height * 0.6096032, + ); + path_0.cubicTo( + size.width * 0.6517976, + size.height * 0.6136032, + size.width * 0.6544008, + size.height * 0.6172024, + size.width * 0.6581984, + size.height * 0.6200040, + ); + path_0.close(); + + final Paint paint0fill = Paint()..style = PaintingStyle.fill; + paint0fill.color = const Color(0xff31BB6B).withOpacity(1.0); + canvas.drawPath(path_0, paint0fill); + + final Path path_1 = Path(); + path_1.moveTo(size.width * 0.5405992, size.height * 0.4396032); + path_1.cubicTo( + size.width * 0.5084008, + size.height * 0.4512024, + size.width * 0.4754008, + size.height * 0.4532024, + size.width * 0.4418016, + size.height * 0.4472024, + ); + path_1.cubicTo( + size.width * 0.4292024, + size.height * 0.4490000, + size.width * 0.4184008, + size.height * 0.4428016, + size.width * 0.4078016, + size.height * 0.4382024, + ); + path_1.cubicTo( + size.width * 0.3772004, + size.height * 0.4248016, + size.width * 0.3516004, + size.height * 0.4048016, + size.width * 0.3326004, + size.height * 0.3768020, + ); + path_1.cubicTo( + size.width * 0.3302004, + size.height * 0.3732020, + size.width * 0.3276004, + size.height * 0.3696020, + size.width * 0.3278004, + size.height * 0.3650020, + ); + path_1.cubicTo( + size.width * 0.3124004, + size.height * 0.3368020, + size.width * 0.3032004, + size.height * 0.3070020, + size.width * 0.3040004, + size.height * 0.2746020, + ); + path_1.cubicTo( + size.width * 0.3056004, + size.height * 0.2126020, + size.width * 0.3322004, + size.height * 0.1636020, + size.width * 0.3842004, + size.height * 0.1300020, + ); + path_1.cubicTo( + size.width * 0.4872024, + size.height * 0.06320198, + size.width * 0.6244008, + size.height * 0.1212020, + size.width * 0.6494008, + size.height * 0.2418020, + ); + path_1.cubicTo( + size.width * 0.6554008, + size.height * 0.2704020, + size.width * 0.6535992, + size.height * 0.2994020, + size.width * 0.6452024, + size.height * 0.3276020, + ); + path_1.cubicTo( + size.width * 0.6444008, + size.height * 0.3302020, + size.width * 0.6440000, + size.height * 0.3328020, + size.width * 0.6434008, + size.height * 0.3354020, + ); + path_1.cubicTo( + size.width * 0.6380000, + size.height * 0.3574020, + size.width * 0.6260000, + size.height * 0.3756020, + size.width * 0.6118016, + size.height * 0.3924020, + ); + path_1.cubicTo( + size.width * 0.5960000, + size.height * 0.4108016, + size.width * 0.5770000, + size.height * 0.4252024, + size.width * 0.5548016, + size.height * 0.4354008, + ); + path_1.cubicTo( + size.width * 0.5500000, + size.height * 0.4376032, + size.width * 0.5455992, + size.height * 0.4394008, + size.width * 0.5405992, + size.height * 0.4396032, + ); + path_1.close(); + + final Paint paint1fill = Paint()..style = PaintingStyle.fill; + paint1fill.color = const Color(0xffFEBC59).withOpacity(1.0); + canvas.drawPath(path_1, paint1fill); + + final Path path_2 = Path(); + path_2.moveTo(size.width * 0.5405992, size.height * 0.4395992); + path_2.cubicTo( + size.width * 0.5880000, + size.height * 0.4200000, + size.width * 0.6224008, + size.height * 0.3870008, + size.width * 0.6410000, + size.height * 0.3386008, + ); + path_2.cubicTo( + size.width * 0.6414008, + size.height * 0.3374008, + size.width * 0.6425992, + size.height * 0.3364008, + size.width * 0.6434008, + size.height * 0.3354008, + ); + path_2.cubicTo( + size.width * 0.6850000, + size.height * 0.4020000, + size.width * 0.7265992, + size.height * 0.4688016, + size.width * 0.7685992, + size.height * 0.5352024, + ); + path_2.cubicTo( + size.width * 0.7742024, + size.height * 0.5440000, + size.width * 0.7724008, + size.height * 0.5470000, + size.width * 0.7642024, + size.height * 0.5520000, + ); + path_2.cubicTo( + size.width * 0.7285992, + size.height * 0.5740000, + size.width * 0.6924008, + size.height * 0.5954008, + size.width * 0.6584008, + size.height * 0.6200000, + ); + path_2.cubicTo( + size.width * 0.6535992, + size.height * 0.6225992, + size.width * 0.6520000, + size.height * 0.6190000, + size.width * 0.6502024, + size.height * 0.6158016, + ); + path_2.cubicTo( + size.width * 0.6158016, + size.height * 0.5590000, + size.width * 0.5814008, + size.height * 0.5022024, + size.width * 0.5470000, + size.height * 0.4455992, + ); + path_2.cubicTo( + size.width * 0.5452024, + size.height * 0.4430000, + size.width * 0.5440000, + size.height * 0.4402024, + size.width * 0.5405992, + size.height * 0.4395992, + ); + path_2.close(); + + final Paint paint2fill = Paint()..style = PaintingStyle.fill; + paint2fill.color = const Color(0xff737373).withOpacity(1.0); + canvas.drawPath(path_2, paint2fill); + + final Path path_3 = Path(); + path_3.moveTo(size.width * 0.3277992, size.height * 0.3651976); + path_3.cubicTo( + size.width * 0.3541992, + size.height * 0.4085992, + size.width * 0.3929992, + size.height * 0.4351984, + size.width * 0.4417976, + size.height * 0.4471984, + ); + path_3.cubicTo( + size.width * 0.4287976, + size.height * 0.4623968, + size.width * 0.4197976, + size.height * 0.4803968, + size.width * 0.4094008, + size.height * 0.4973968, + ); + path_3.cubicTo( + size.width * 0.3847992, + size.height * 0.5373968, + size.width * 0.3591992, + size.height * 0.5765992, + size.width * 0.3361992, + size.height * 0.6173968, + ); + path_3.cubicTo( + size.width * 0.3347992, + size.height * 0.6197976, + size.width * 0.3333992, + size.height * 0.6219960, + size.width * 0.3301992, + size.height * 0.6215992, + ); + path_3.cubicTo( + size.width * 0.3235992, + size.height * 0.6143968, + size.width * 0.3149992, + size.height * 0.6097976, + size.width * 0.3069992, + size.height * 0.6045992, + ); + path_3.cubicTo( + size.width * 0.2783992, + size.height * 0.5863968, + size.width * 0.2493992, + size.height * 0.5685992, + size.width * 0.2205992, + size.height * 0.5507976, + ); + path_3.cubicTo( + size.width * 0.2163992, + size.height * 0.5481984, + size.width * 0.2131992, + size.height * 0.5465992, + size.width * 0.2169992, + size.height * 0.5403968, + ); + path_3.cubicTo( + size.width * 0.2535992, + size.height * 0.4825992, + size.width * 0.2899992, + size.height * 0.4243968, + size.width * 0.3263992, + size.height * 0.3663976, + ); + path_3.cubicTo( + size.width * 0.3265992, + size.height * 0.3659976, + size.width * 0.3271992, + size.height * 0.3655976, + size.width * 0.3277992, + size.height * 0.3651976, + ); + path_3.close(); + + final Paint paint3fill = Paint()..style = PaintingStyle.fill; + paint3fill.color = const Color(0xff737373).withOpacity(1.0); + canvas.drawPath(path_3, paint3fill); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md new file mode 100644 index 0000000000..bbd772e40a --- /dev/null +++ b/talawa-mobile-docs/custom_painters_talawa_logo/AppLogo/shouldRepaint.md @@ -0,0 +1,58 @@ + + + +# shouldRepaint method + + + + + + + +- @[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) + +_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 +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 +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.

+ + + +## Implementation + +```dart +@override +bool shouldRepaint(covariant CustomPainter oldDelegate) { + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_talawa_logo/custom_painters_talawa_logo-library.md b/talawa-mobile-docs/custom_painters_talawa_logo/custom_painters_talawa_logo-library.md new file mode 100644 index 0000000000..5c5e7aba1d --- /dev/null +++ b/talawa-mobile-docs/custom_painters_talawa_logo/custom_painters_talawa_logo-library.md @@ -0,0 +1,40 @@ + + + + +# talawa_logo library + + + + + + + + + + + +## Classes + +##### [AppLogo](../custom_painters_talawa_logo/AppLogo-class.md) + + + +This class draws the app logo using custom paint. +CustomPaint is a widget from the Flutter SDK, which enables +you to use a canvas to draw different shapes. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo-class.md b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo-class.md new file mode 100644 index 0000000000..12b1a1e0a7 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo-class.md @@ -0,0 +1,183 @@ + + + +# TelegramLogo class + + + + + + + + + +

This class draws the telegram logo using custom paint. +CustomPaint is a widget from the Flutter SDK, which enables +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) +- TelegramLogo + + + + + + + + +## Constructors + +[TelegramLogo](../custom_painters_telegram_logo/TelegramLogo/TelegramLogo.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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 +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_ + + + +##### [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_ + + + +##### [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 +delegate class (which amounts to the same thing, because the latter is +implemented in terms of the former). +_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) + + + +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). +_override_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/TelegramLogo.md b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/TelegramLogo.md new file mode 100644 index 0000000000..4d5cfd0379 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/TelegramLogo.md @@ -0,0 +1,24 @@ + + + +# TelegramLogo constructor + + + + + + + +TelegramLogo() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md new file mode 100644 index 0000000000..fdec6895d4 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/paint.md @@ -0,0 +1,171 @@ + + + +# paint method + + + + + + + +- @[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) + +_override_ + + + +

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 +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 +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. +
+ + + +## Implementation + +```dart +@override +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), + Offset(size.width * 0.4170000, size.height * 0.7500000), [ + const Color(0xff37aee2).withOpacity(1), + const Color(0xff1e96c8).withOpacity(1) + ], [ + 0, + 1 + ]); + canvas.drawCircle( + Offset(size.width * 0.5000000, size.height * 0.5000000), + size.width * 0.5000000, + paint0Fill, + ); + + final Path path_1 = Path(); + path_1.moveTo(size.width * 0.4083333, size.height * 0.7291667); + path_1.cubicTo( + size.width * 0.3921333, + size.height * 0.7291667, + size.width * 0.3948875, + size.height * 0.7230500, + size.width * 0.3893000, + size.height * 0.7076250, + ); + path_1.lineTo(size.width * 0.3416667, size.height * 0.5508625); + path_1.lineTo(size.width * 0.7083333, size.height * 0.3333333); + + final Paint paint1Fill = Paint()..style = PaintingStyle.fill; + paint1Fill.color = const Color(0xffc8daea).withOpacity(1.0); + canvas.drawPath(path_1, paint1Fill); + + final Path path_2 = Path(); + path_2.moveTo(size.width * 0.4083333, size.height * 0.7291667); + path_2.cubicTo( + size.width * 0.4208333, + size.height * 0.7291667, + size.width * 0.4263542, + size.height * 0.7234500, + size.width * 0.4333333, + size.height * 0.7166667, + ); + path_2.lineTo(size.width * 0.5000000, size.height * 0.6518417); + path_2.lineTo(size.width * 0.4168417, size.height * 0.6016958); + + final Paint paint2Fill = Paint()..style = PaintingStyle.fill; + paint2Fill.color = const Color(0xffa9c9dd).withOpacity(1.0); + canvas.drawPath(path_2, paint2Fill); + + final Path path_3 = Path(); + path_3.moveTo(size.width * 0.4168333, size.height * 0.6017083); + path_3.lineTo(size.width * 0.6183333, size.height * 0.7505792); + path_3.cubicTo( + size.width * 0.6413292, + size.height * 0.7632667, + size.width * 0.6579208, + size.height * 0.7566958, + size.width * 0.6636500, + size.height * 0.7292333, + ); + path_3.lineTo(size.width * 0.7456708, size.height * 0.3427208); + path_3.cubicTo( + size.width * 0.7540667, + size.height * 0.3090542, + size.width * 0.7328375, + size.height * 0.2937792, + size.width * 0.7108375, + size.height * 0.3037667, + ); + path_3.lineTo(size.width * 0.2292125, size.height * 0.4894792); + path_3.cubicTo( + size.width * 0.1963375, + size.height * 0.5026667, + size.width * 0.1965333, + size.height * 0.5210083, + size.width * 0.2232208, + size.height * 0.5291792, + ); + path_3.lineTo(size.width * 0.3468167, size.height * 0.5677583); + path_3.lineTo(size.width * 0.6329542, size.height * 0.3872375); + path_3.cubicTo( + size.width * 0.6464625, + size.height * 0.3790458, + size.width * 0.6588625, + size.height * 0.3834458, + size.width * 0.6486875, + size.height * 0.3924792, + ); + + final Paint paint3Fill = Paint()..style = PaintingStyle.fill; + paint3Fill.shader = ui.Gradient.linear( + Offset(size.width * 0.6600000, size.height * 0.4370000), + Offset(size.width * 0.8510000, size.height * 0.8020000), [ + const Color(0xffeff7fc).withOpacity(1), + const Color(0xffffffff).withOpacity(1) + ], [ + 0, + 1 + ]); + canvas.drawPath(path_3, paint3Fill); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md new file mode 100644 index 0000000000..255d4828a6 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md @@ -0,0 +1,58 @@ + + + +# shouldRepaint method + + + + + + + +- @[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) + +_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 +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 +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.

+ + + +## Implementation + +```dart +@override +bool shouldRepaint(covariant CustomPainter oldDelegate) { + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_telegram_logo/custom_painters_telegram_logo-library.md b/talawa-mobile-docs/custom_painters_telegram_logo/custom_painters_telegram_logo-library.md new file mode 100644 index 0000000000..4dad766a1c --- /dev/null +++ b/talawa-mobile-docs/custom_painters_telegram_logo/custom_painters_telegram_logo-library.md @@ -0,0 +1,40 @@ + + + + +# telegram_logo library + + + + + + + + + + + +## Classes + +##### [TelegramLogo](../custom_painters_telegram_logo/TelegramLogo-class.md) + + + +This class draws the telegram logo using custom paint. +CustomPaint is a widget from the Flutter SDK, which enables +you to use a canvas to draw different shapes. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo-class.md b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo-class.md new file mode 100644 index 0000000000..71a314a26f --- /dev/null +++ b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo-class.md @@ -0,0 +1,183 @@ + + + +# WhatsappLogo class + + + + + + + + + +

This class draws the whatsapp logo using custom paint. +CustomPaint is a widget from the Flutter SDK, which enables +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) +- WhatsappLogo + + + + + + + + +## Constructors + +[WhatsappLogo](../custom_painters_whatsapp_logo/WhatsappLogo/WhatsappLogo.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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 +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_ + + + +##### [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_ + + + +##### [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 +delegate class (which amounts to the same thing, because the latter is +implemented in terms of the former). +_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) + + + +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). +_override_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/WhatsappLogo.md b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/WhatsappLogo.md new file mode 100644 index 0000000000..e75ac5d536 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/WhatsappLogo.md @@ -0,0 +1,24 @@ + + + +# WhatsappLogo constructor + + + + + + + +WhatsappLogo() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md new file mode 100644 index 0000000000..ff1a5a712d --- /dev/null +++ b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/paint.md @@ -0,0 +1,485 @@ + + + +# paint method + + + + + + + +- @[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) + +_override_ + + + +

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 +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 +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. +
+ + + +## Implementation + +```dart +@override +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( + size.width * 0.4170000, + size.height * 0.1406375, + size.width * 0.4836000, + size.height * 0.1314741, + size.width * 0.5480000, + size.height * 0.1400398, + ); + path_0.cubicTo( + size.width * 0.6134000, + size.height * 0.1486056, + size.width * 0.6760000, + size.height * 0.1764940, + size.width * 0.7260000, + size.height * 0.2193227, + ); + path_0.cubicTo( + size.width * 0.7740000, + size.height * 0.2595618, + size.width * 0.8106000, + size.height * 0.3129482, + size.width * 0.8308000, + size.height * 0.3719124, + ); + path_0.cubicTo( + size.width * 0.8540000, + size.height * 0.4390438, + size.width * 0.8558000, + size.height * 0.5133466, + size.width * 0.8360000, + size.height * 0.5810757, + ); + path_0.arcToPoint( + Offset(size.width * 0.7034000, size.height * 0.7677291), + radius: + Radius.elliptical(size.width * 0.3520000, size.height * 0.3505976), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_0.arcToPoint( + Offset(size.width * 0.5662000, size.height * 0.8264940), + radius: + Radius.elliptical(size.width * 0.3500000, size.height * 0.3486056), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_0.cubicTo( + size.width * 0.4822000, + size.height * 0.8424303, + size.width * 0.3930000, + size.height * 0.8268924, + size.width * 0.3202000, + size.height * 0.7826693, + ); + path_0.cubicTo( + size.width * 0.3156000, + size.height * 0.7806773, + size.width * 0.3112000, + size.height * 0.7756972, + size.width * 0.3058000, + size.height * 0.7778884, + ); + path_0.lineTo(size.width * 0.1780000, size.height * 0.8107570); + path_0.lineTo(size.width * 0.2120000, size.height * 0.6864542); + path_0.cubicTo( + size.width * 0.2140000, + size.height * 0.6820717, + size.width * 0.2100000, + size.height * 0.6784861, + size.width * 0.2080000, + size.height * 0.6745020, + ); + path_0.cubicTo( + size.width * 0.1694000, + size.height * 0.6159363, + size.width * 0.1494000, + size.height * 0.5454183, + size.width * 0.1514000, + size.height * 0.4752988, + ); + path_0.cubicTo( + size.width * 0.1534000, + size.height * 0.3318725, + size.width * 0.2454000, + size.height * 0.2183267, + size.width * 0.3574000, + size.height * 0.1665339, + ); + + final Paint paint0Fill = Paint()..style = PaintingStyle.fill; + paint0Fill.color = const Color(0xff40c351).withOpacity(1.0); + canvas.drawPath(path_0, paint0Fill); + + final Path path_1 = Path(); + path_1.moveTo(size.width * 0.3760000, size.height * 0.2908367); + path_1.cubicTo( + size.width * 0.3854000, + size.height * 0.2910359, + size.width * 0.3916000, + size.height * 0.2994024, + size.width * 0.3952000, + size.height * 0.3067729, + ); + path_1.cubicTo( + size.width * 0.4072000, + size.height * 0.3326693, + size.width * 0.4168000, + size.height * 0.3593625, + size.width * 0.4282000, + size.height * 0.3854582, + ); + path_1.cubicTo( + size.width * 0.4306000, + size.height * 0.3908367, + size.width * 0.4322000, + size.height * 0.3968127, + size.width * 0.4302000, + size.height * 0.4025896, + ); + path_1.cubicTo( + size.width * 0.4242000, + size.height * 0.4195219, + size.width * 0.4102000, + size.height * 0.4316733, + size.width * 0.3990000, + size.height * 0.4452191, + ); + path_1.cubicTo( + size.width * 0.3950000, + size.height * 0.4498008, + size.width * 0.3954000, + size.height * 0.4563745, + size.width * 0.3986000, + size.height * 0.4611554, + ); + path_1.arcToPoint( + Offset(size.width * 0.5456000, size.height * 0.5876494), + radius: + Radius.elliptical(size.width * 0.2600000, size.height * 0.2589641), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.cubicTo( + size.width * 0.5516000, + size.height * 0.5902390, + size.width * 0.5588000, + size.height * 0.5896414, + size.width * 0.5630000, + size.height * 0.5844622, + ); + path_1.arcToPoint( + Offset(size.width * 0.5970000, size.height * 0.5428287), + radius: + Radius.elliptical(size.width * 0.5640000, size.height * 0.5617530), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.cubicTo( + size.width * 0.6062000, + size.height * 0.5308765, + size.width * 0.6142000, + size.height * 0.5342629, + size.width * 0.6262000, + size.height * 0.5392430, + ); + path_1.lineTo(size.width * 0.7030000, size.height * 0.5760956); + path_1.cubicTo( + size.width * 0.7090000, + size.height * 0.5786853, + size.width * 0.7150000, + size.height * 0.5830677, + size.width * 0.7144000, + size.height * 0.5900398, + ); + path_1.cubicTo( + size.width * 0.7184000, + size.height * 0.6418327, + size.width * 0.6718000, + size.height * 0.6820717, + size.width * 0.6230000, + size.height * 0.6836653, + ); + path_1.cubicTo( + size.width * 0.4970000, + size.height * 0.6745020, + size.width * 0.4110000, + size.height * 0.6047809, + size.width * 0.3490000, + size.height * 0.5243028, + ); + path_1.cubicTo( + size.width * 0.3286000, + size.height * 0.4960159, + size.width * 0.3070000, + size.height * 0.4675299, + size.width * 0.2958000, + size.height * 0.4338645, + ); + path_1.cubicTo( + size.width * 0.2852000, + size.height * 0.4043825, + size.width * 0.2848000, + size.height * 0.3707171, + size.width * 0.2974000, + size.height * 0.3416335, + ); + path_1.cubicTo( + size.width * 0.3168000, + size.height * 0.3027888, + size.width * 0.3338000, + size.height * 0.2878486, + size.width * 0.3766000, + size.height * 0.2902390, + ); + path_1.close(); + path_1.moveTo(size.width * 0.2580000, size.height * 0.1422311); + path_1.cubicTo( + size.width * 0.3504000, + size.height * 0.07649402, + size.width * 0.4700000, + size.height * 0.05139442, + size.width * 0.5820000, + size.height * 0.07370518, + ); + path_1.arcToPoint( + Offset(size.width * 0.7774000, size.height * 0.1699203), + radius: + Radius.elliptical(size.width * 0.4180000, size.height * 0.4163347), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.arcToPoint( + Offset(size.width * 0.9178000, size.height * 0.4368526), + radius: + Radius.elliptical(size.width * 0.4200000, size.height * 0.4183267), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.arcToPoint( + Offset(size.width * 0.8918000, size.height * 0.6380478), + radius: + Radius.elliptical(size.width * 0.4220000, size.height * 0.4203187), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.cubicTo( + size.width * 0.8622000, + size.height * 0.7137450, + size.width * 0.8098000, + size.height * 0.7802789, + size.width * 0.7434000, + size.height * 0.8272908, + ); + path_1.arcToPoint( + Offset(size.width * 0.5254000, size.height * 0.9039841), + radius: + Radius.elliptical(size.width * 0.4180000, size.height * 0.4163347), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.arcToPoint( + Offset(size.width * 0.2994000, size.height * 0.8541833), + radius: + Radius.elliptical(size.width * 0.4200000, size.height * 0.4183267), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.lineTo(size.width * 0.07540000, size.height * 0.9119522); + path_1.lineTo(size.width * 0.1344000, size.height * 0.6968127); + path_1.cubicTo( + size.width * 0.1356000, + size.height * 0.6942231, + size.width * 0.1338000, + size.height * 0.6920319, + size.width * 0.1324000, + size.height * 0.6900398, + ); + path_1.arcToPoint( + Offset(size.width * 0.08240000, size.height * 0.4310757), + radius: + Radius.elliptical(size.width * 0.4200000, size.height * 0.4183267), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.arcToPoint( + Offset(size.width * 0.2574000, size.height * 0.1422311), + radius: + Radius.elliptical(size.width * 0.4260000, size.height * 0.4243028), + rotation: 0, + largeArc: false, + clockwise: true, + ); + path_1.moveTo(size.width * 0.3568000, size.height * 0.1673307); + path_1.cubicTo( + size.width * 0.2898000, + size.height * 0.1972112, + size.width * 0.2328000, + size.height * 0.2486056, + size.width * 0.1964000, + size.height * 0.3121514, + ); + path_1.cubicTo( + size.width * 0.1676000, + size.height * 0.3619522, + size.width * 0.1516000, + size.height * 0.4187251, + size.width * 0.1504000, + size.height * 0.4760956, + ); + path_1.cubicTo( + size.width * 0.1484000, + size.height * 0.5462151, + size.width * 0.1684000, + size.height * 0.6165339, + size.width * 0.2070000, + size.height * 0.6752988, + ); + path_1.cubicTo( + size.width * 0.2090000, + size.height * 0.6788845, + size.width * 0.2126000, + size.height * 0.6826693, + size.width * 0.2110000, + size.height * 0.6872510, + ); + path_1.lineTo(size.width * 0.1770000, size.height * 0.8115538); + path_1.cubicTo( + size.width * 0.2196000, + size.height * 0.8007968, + size.width * 0.2622000, + size.height * 0.7892430, + size.width * 0.3050000, + size.height * 0.7784861, + ); + path_1.cubicTo( + size.width * 0.3104000, + size.height * 0.7764940, + size.width * 0.3150000, + size.height * 0.7808765, + size.width * 0.3194000, + size.height * 0.7832669, + ); + path_1.arcToPoint( + Offset(size.width * 0.5654000, size.height * 0.8272908), + radius: + Radius.elliptical(size.width * 0.3500000, size.height * 0.3486056), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.arcToPoint( + Offset(size.width * 0.7026000, size.height * 0.7685259), + radius: + Radius.elliptical(size.width * 0.3460000, size.height * 0.3446215), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.arcToPoint( + Offset(size.width * 0.8352000, size.height * 0.5818725), + radius: + Radius.elliptical(size.width * 0.3520000, size.height * 0.3505976), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.arcToPoint( + Offset(size.width * 0.8300000, size.height * 0.3727092), + radius: + Radius.elliptical(size.width * 0.3500000, size.height * 0.3486056), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.arcToPoint( + Offset(size.width * 0.7252000, size.height * 0.2201195), + radius: + Radius.elliptical(size.width * 0.3500000, size.height * 0.3486056), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.arcToPoint( + Offset(size.width * 0.5470000, size.height * 0.1408367), + radius: + Radius.elliptical(size.width * 0.3480000, size.height * 0.3466135), + rotation: 0, + largeArc: false, + clockwise: false, + ); + path_1.cubicTo( + size.width * 0.4830000, + size.height * 0.1322709, + size.width * 0.4162000, + size.height * 0.1414343, + size.width * 0.3570000, + size.height * 0.1681275, + ); + path_1.close(); + + final Paint paint1fill = Paint()..style = PaintingStyle.fill; + paint1fill.color = const Color(0xfffcfcfc).withOpacity(1.0); + canvas.drawPath(path_1, paint1fill); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md new file mode 100644 index 0000000000..886f0bbbba --- /dev/null +++ b/talawa-mobile-docs/custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md @@ -0,0 +1,58 @@ + + + +# shouldRepaint method + + + + + + + +- @[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) + +_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 +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 +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.

+ + + +## Implementation + +```dart +@override +bool shouldRepaint(covariant CustomPainter oldDelegate) { + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/custom_painters_whatsapp_logo/custom_painters_whatsapp_logo-library.md b/talawa-mobile-docs/custom_painters_whatsapp_logo/custom_painters_whatsapp_logo-library.md new file mode 100644 index 0000000000..9c46465087 --- /dev/null +++ b/talawa-mobile-docs/custom_painters_whatsapp_logo/custom_painters_whatsapp_logo-library.md @@ -0,0 +1,40 @@ + + + + +# whatsapp_logo library + + + + + + + + + + + +## Classes + +##### [WhatsappLogo](../custom_painters_whatsapp_logo/WhatsappLogo-class.md) + + + +This class draws the whatsapp logo using custom paint. +CustomPaint is a widget from the Flutter SDK, which enables +you to use a canvas to draw different shapes. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_direct_chat_demo_data/demo_server_data_direct_chat_demo_data-library.md b/talawa-mobile-docs/demo_server_data_direct_chat_demo_data/demo_server_data_direct_chat_demo_data-library.md new file mode 100644 index 0000000000..5a7cd4e323 --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_direct_chat_demo_data/demo_server_data_direct_chat_demo_data-library.md @@ -0,0 +1,40 @@ + + + + +# direct_chat_demo_data library + + + + + + + + + + + + + + +## Constants + +##### [directChatDemoData](../demo_server_data_direct_chat_demo_data/directChatDemoData-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)>> + + + +This file contains demo data. + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_direct_chat_demo_data/directChatDemoData-constant.md b/talawa-mobile-docs/demo_server_data_direct_chat_demo_data/directChatDemoData-constant.md new file mode 100644 index 0000000000..213ffe978e --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_direct_chat_demo_data/directChatDemoData-constant.md @@ -0,0 +1,200 @@ + + + +# directChatDemoData top-level constant + + + + + + + + + +[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 directChatDemoData + + + + + +

This file contains demo data.

+

It contains a list of type Map<String, Object> and sample data of chats.

+ + + +## Implementation + +```dart +const directChatDemoData = [ + { + "sender": { + "name": "Sender 1", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Last message from the sender.", + "bool": "True" + }, + "unreadCount": 6, + }, + { + "sender": { + "name": "Sender 2", + "id": "sadiufghbasdqwuibnnads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Last message from the sender.", + "bool": "True" + }, + "unreadCount": 6, + }, + { + "sender": { + "name": "Sender 8", + "id": "sadiusfgafghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 3, + }, + { + "sender": { + "name": "Sender 7", + "id": "sasdasddiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 3, + }, + { + "sender": { + "name": "Sender 6", + "id": "sadiufghbassadasddqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 3, + }, + { + "sender": { + "name": "Sender 5", + "id": "sadiufghbasdqwsaduibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender 5", + "id": "sadiufghbasdqwdfdibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 3, + }, + { + "sender": { + "name": "Sender 4", + "id": "sadiufghbsdasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 3, + }, + { + "sender": { + "name": "Sender 41", + "id": "sadiufghbadgsdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 1, + }, + { + "sender": { + "name": "Sender 13", + "id": "sadiufghbadsfsdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "lastMessage": { + "sender": { + "name": "Sender Name", + "id": "sadiufghbasdqwuibnuads", + "image": "sender_profile_inmage_url" + }, + "messageID": "asdasdfasdfgasdf", + "text": "Latest message", + "bool": "True" + }, + "unreadCount": 8, + }, +]; +``` + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_events_demo_data/demo_server_data_events_demo_data-library.md b/talawa-mobile-docs/demo_server_data_events_demo_data/demo_server_data_events_demo_data-library.md new file mode 100644 index 0000000000..64a23f76dc --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_events_demo_data/demo_server_data_events_demo_data-library.md @@ -0,0 +1,41 @@ + + + + +# events_demo_data library + + + + + + + + + + + + + + +## Constants + +##### [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)>> + + + +This file contains demo data. It contains a list of type Map<String, Object> +and sample data of events. + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md b/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md new file mode 100644 index 0000000000..72455cde72 --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_events_demo_data/eventsDemoData-constant.md @@ -0,0 +1,229 @@ + + + +# eventsDemoData top-level constant + + + + + + + + + +[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.

+ + + +## Implementation + +```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.", + "attendees": "50", + "location": "Lostilos", + "recurring": "false", + "allDay": "true", + "startDate": "1 Aug", + "endDate": "15 Aug", + "startTime": "11am", + "endTime": "3pm", + "recurrence": "MONTHLY", + "isPublic": "true", + "isSubscribed": "false", + "isRegisterable": "true", + "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"}, + ], + "admins": [ + {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + ], + "organization": { + "_id": '1', + "name": 'Mathematicians', + "image": ' ', + "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.", + "attendees": "80", + "location": "Tokyo, Japan", + "recurring": "false", + "allDay": "true", + "startDate": "5 May", + "endDate": "13 May", + "startTime": "2am", + "endTime": "3pm", + "recurrence": "MONTHLY", + "isPublic": "true", + "isSubscribed": "true", + "isRegisterable": "true", + "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"}, + ], + "admins": [ + {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + ], + "organization": { + "_id": '1', + "name": 'Courses', + "image": ' ', + "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.", + "attendees": "29", + "location": "Shimla, India", + "recurring": "false", + "allDay": "true", + "startDate": "15 Dec", + "endDate": "18 Aug", + "startTime": "8am", + "endTime": "3pm", + "recurrence": "MONTHLY", + "isPublic": "false", + "isSubscribed": "false", + "isRegisterable": "true", + "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"}, + ], + "admins": [ + {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + ], + "organization": { + "_id": '1', + "image": ' ', + "name": 'Computer Science', + "creator": { + "firstName": "Ritik", + "lastName": "Srivastav", + "_id": "asdasdasd" + } + }, + }, + { + "title": "Gaming", + // 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.", + + "attendees": "5k+", + "location": "Nagpur, India", + "recurring": "false", + "allDay": "true", + "startDate": "1 Aug", + "endDate": "15 Aug", + "startTime": "11am", + "endTime": "3pm", + "recurrence": "MONTHLY", + "isPublic": "true", + "isSubscribed": "true", + "isRegisterable": "true", + + "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"}, + ], + "admins": [ + {"firstName": "Utkarsh", "lastName": "Shendge", "_id": "asdasdasd"}, + ], + "organization": { + "_id": '1', + "image": ' ', + "name": 'Cyclone', + "creator": { + "firstName": "Utkarsh", + "lastName": "Shendge", + "_id": "asdasdasd" + } + }, + } +]; +``` + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md b/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md new file mode 100644 index 0000000000..90c5b02d05 --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md @@ -0,0 +1,40 @@ + + + + +# pinned_post_demo_data library + + + + + + + + + + + + + + +## 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)>> + + + +This file contains demo data for pinned posts. It contains a list of type Map<String, Object> and sample data. + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md b/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md new file mode 100644 index 0000000000..e932c9d7e6 --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md @@ -0,0 +1,193 @@ + + + +# pinnedPostsDemoData top-level constant + + + + + + + + + +[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.

+ + + +## Implementation + +```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": { + "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"} + ], + "comments": [ + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "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": { + "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"} + ], + "comments": [ + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "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": { + "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"} + ], + "comments": [ + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "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": { + "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"} + ], + "comments": [ + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + { + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "id": "asdasdasdas"} + }, + ] + }, +]; +``` + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md b/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md new file mode 100644 index 0000000000..2e26a035ae --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md @@ -0,0 +1,41 @@ + + + + +# post_demo_data library + + + + + + + + + + + + + + +## 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)>> + + + +This file contains demo data for posts. It contains a list of type Map<String, Object> +and sample data of posts. + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md b/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md new file mode 100644 index 0000000000..aa96891f79 --- /dev/null +++ b/talawa-mobile-docs/demo_server_data_post_demo_data/postsDemoData-constant.md @@ -0,0 +1,214 @@ + + + +# postsDemoData top-level constant + + + + + + + + + +[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.

+ + + +## Implementation + +```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": { + "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"} + ], + "comments": [ + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "1", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "2", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "3", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "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": { + "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"} + ], + "comments": [ + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "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": { + "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"} + ], + "comments": [ + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "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": { + "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"} + ], + "comments": [ + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + { + "_id": "commentID", + "text": "This is the posted comment", + "creator": {"firstName": "User", "lastName": "4", "_id": "asdasdasdas"} + }, + ] + }, +]; +``` + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/CallFor.md b/talawa-mobile-docs/enums_enums/CallFor.md new file mode 100644 index 0000000000..c508c61108 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/CallFor.md @@ -0,0 +1,149 @@ + + + +# CallFor enum + + + + + + + + + + +**Inheritance** + +- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- CallFor + + + + + + +## Constructors + +[CallFor](../enums_enums/CallFor/CallFor.md) () + + _const_ + + +## Values + +##### [login](../enums_enums/CallFor.md) const [CallFor](../enums_enums/CallFor.md) + + + + + + + + +##### [signup](../enums_enums/CallFor.md) const [CallFor](../enums_enums/CallFor.md) + + + + + + + + +##### [joinPublicOrg](../enums_enums/CallFor.md) const [CallFor](../enums_enums/CallFor.md) + + + + + + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + +A constant List of the values in this enum, in order of their declaration. + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/CallFor/CallFor.md b/talawa-mobile-docs/enums_enums/CallFor/CallFor.md new file mode 100644 index 0000000000..1f869b15f5 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/CallFor/CallFor.md @@ -0,0 +1,24 @@ + + + +# CallFor constructor + + + + + + +const +CallFor() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/CallFor/values-constant.md b/talawa-mobile-docs/enums_enums/CallFor/values-constant.md new file mode 100644 index 0000000000..cff3cf6c21 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/CallFor/values-constant.md @@ -0,0 +1,28 @@ + + + +# values constant + + + + + + + +[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.

+ + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ChatState.md b/talawa-mobile-docs/enums_enums/ChatState.md new file mode 100644 index 0000000000..739acc0253 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ChatState.md @@ -0,0 +1,150 @@ + + + +# ChatState enum + + + + + + + +

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) +- ChatState + + + + + + +## Constructors + +[ChatState](../enums_enums/ChatState/ChatState.md) () + + _const_ + + +## Values + +##### [initial](../enums_enums/ChatState.md) const [ChatState](../enums_enums/ChatState.md) + + + + + + + + +##### [loading](../enums_enums/ChatState.md) const [ChatState](../enums_enums/ChatState.md) + + + + + + + + +##### [complete](../enums_enums/ChatState.md) const [ChatState](../enums_enums/ChatState.md) + + + + + + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + +A constant List of the values in this enum, in order of their declaration. + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ChatState/ChatState.md b/talawa-mobile-docs/enums_enums/ChatState/ChatState.md new file mode 100644 index 0000000000..1d0a6f3034 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ChatState/ChatState.md @@ -0,0 +1,24 @@ + + + +# ChatState constructor + + + + + + +const +ChatState() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ChatState/values-constant.md b/talawa-mobile-docs/enums_enums/ChatState/values-constant.md new file mode 100644 index 0000000000..8d2ba60b5c --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ChatState/values-constant.md @@ -0,0 +1,28 @@ + + + +# values constant + + + + + + + +[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.

+ + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/MessageType.md b/talawa-mobile-docs/enums_enums/MessageType.md new file mode 100644 index 0000000000..5bc119ab1b --- /dev/null +++ b/talawa-mobile-docs/enums_enums/MessageType.md @@ -0,0 +1,159 @@ + + + +# MessageType enum + + + + + + + +

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) +- MessageType + + + + + + +## Constructors + +[MessageType](../enums_enums/MessageType/MessageType.md) () + + _const_ + + +## Values + +##### [error](../enums_enums/MessageType.md) const [MessageType](../enums_enums/MessageType.md) + + + + + + + + +##### [warning](../enums_enums/MessageType.md) const [MessageType](../enums_enums/MessageType.md) + + + + + + + + +##### [info](../enums_enums/MessageType.md) const [MessageType](../enums_enums/MessageType.md) + + + + + + + + +##### [random](../enums_enums/MessageType.md) const [MessageType](../enums_enums/MessageType.md) + + + + + + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + +A constant List of the values in this enum, in order of their declaration. + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/MessageType/MessageType.md b/talawa-mobile-docs/enums_enums/MessageType/MessageType.md new file mode 100644 index 0000000000..cfa1c55e68 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/MessageType/MessageType.md @@ -0,0 +1,24 @@ + + + +# MessageType constructor + + + + + + +const +MessageType() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/MessageType/values-constant.md b/talawa-mobile-docs/enums_enums/MessageType/values-constant.md new file mode 100644 index 0000000000..d6a40b6241 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/MessageType/values-constant.md @@ -0,0 +1,28 @@ + + + +# values constant + + + + + + + +[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.

+ + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ModalSheet.md b/talawa-mobile-docs/enums_enums/ModalSheet.md new file mode 100644 index 0000000000..ddfe171d2c --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ModalSheet.md @@ -0,0 +1,140 @@ + + + +# ModalSheet enum + + + + + + + + + + +**Inheritance** + +- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- ModalSheet + + + + + + +## Constructors + +[ModalSheet](../enums_enums/ModalSheet/ModalSheet.md) () + + _const_ + + +## Values + +##### [donation](../enums_enums/ModalSheet.md) const [ModalSheet](../enums_enums/ModalSheet.md) + + + + + + + + +##### [invite](../enums_enums/ModalSheet.md) const [ModalSheet](../enums_enums/ModalSheet.md) + + + + + + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + +A constant List of the values in this enum, in order of their declaration. + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ModalSheet/ModalSheet.md b/talawa-mobile-docs/enums_enums/ModalSheet/ModalSheet.md new file mode 100644 index 0000000000..28f3e9e6ef --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ModalSheet/ModalSheet.md @@ -0,0 +1,24 @@ + + + +# ModalSheet constructor + + + + + + +const +ModalSheet() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md b/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md new file mode 100644 index 0000000000..b1da27eac8 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ModalSheet/values-constant.md @@ -0,0 +1,28 @@ + + + +# values constant + + + + + + + +[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.

+ + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/TileType.md b/talawa-mobile-docs/enums_enums/TileType.md new file mode 100644 index 0000000000..0064128683 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/TileType.md @@ -0,0 +1,150 @@ + + + +# TileType enum + + + + + + + +

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) +- TileType + + + + + + +## Constructors + +[TileType](../enums_enums/TileType/TileType.md) () + + _const_ + + +## Values + +##### [user](../enums_enums/TileType.md) const [TileType](../enums_enums/TileType.md) + + + + + + + + +##### [org](../enums_enums/TileType.md) const [TileType](../enums_enums/TileType.md) + + + + + + + + +##### [option](../enums_enums/TileType.md) const [TileType](../enums_enums/TileType.md) + + + + + + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + +A constant List of the values in this enum, in order of their declaration. + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/TileType/TileType.md b/talawa-mobile-docs/enums_enums/TileType/TileType.md new file mode 100644 index 0000000000..b9500b131d --- /dev/null +++ b/talawa-mobile-docs/enums_enums/TileType/TileType.md @@ -0,0 +1,24 @@ + + + +# TileType constructor + + + + + + +const +TileType() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/TileType/values-constant.md b/talawa-mobile-docs/enums_enums/TileType/values-constant.md new file mode 100644 index 0000000000..383d264e80 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/TileType/values-constant.md @@ -0,0 +1,28 @@ + + + +# values constant + + + + + + + +[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.

+ + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ViewState.md b/talawa-mobile-docs/enums_enums/ViewState.md new file mode 100644 index 0000000000..d0cb942eb7 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ViewState.md @@ -0,0 +1,144 @@ + + + +# ViewState enum + + + + + + + +

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

+ + + +**Inheritance** + +- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) +- [Enum](https://api.flutter.dev/flutter/dart-core/Enum-class.html) +- ViewState + + + + + + +## Constructors + +[ViewState](../enums_enums/ViewState/ViewState.md) () + + _const_ + + +## Values + +##### [idle](../enums_enums/ViewState.md) const [ViewState](../enums_enums/ViewState.md) + + + + + + + + +##### [busy](../enums_enums/ViewState.md) const [ViewState](../enums_enums/ViewState.md) + + + + + + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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)> + + + +A constant List of the values in this enum, in order of their declaration. + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ViewState/ViewState.md b/talawa-mobile-docs/enums_enums/ViewState/ViewState.md new file mode 100644 index 0000000000..a491a741ca --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ViewState/ViewState.md @@ -0,0 +1,24 @@ + + + +# ViewState constructor + + + + + + +const +ViewState() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/ViewState/values-constant.md b/talawa-mobile-docs/enums_enums/ViewState/values-constant.md new file mode 100644 index 0000000000..6360c8b8db --- /dev/null +++ b/talawa-mobile-docs/enums_enums/ViewState/values-constant.md @@ -0,0 +1,28 @@ + + + +# values constant + + + + + + + +[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.

+ + + + + + + + + + diff --git a/talawa-mobile-docs/enums_enums/enums_enums-library.md b/talawa-mobile-docs/enums_enums/enums_enums-library.md new file mode 100644 index 0000000000..3760572ad4 --- /dev/null +++ b/talawa-mobile-docs/enums_enums/enums_enums-library.md @@ -0,0 +1,76 @@ + + + + +# enums library + + + + + + + + + + + + + + + + + +## Enums + +##### [CallFor](../enums_enums/CallFor.md) + + + + + + +##### [ChatState](../enums_enums/ChatState.md) + + + +Represents the state of the chat + + +##### [MessageType](../enums_enums/MessageType.md) + + + +Represents the type of the Message + + +##### [ModalSheet](../enums_enums/ModalSheet.md) + + + + + + +##### [TileType](../enums_enums/TileType.md) + + + +Represents the type of the tile + + +##### [ViewState](../enums_enums/ViewState.md) + + + +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 + + + + + + + + + diff --git a/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md new file mode 100644 index 0000000000..f8bb745e47 --- /dev/null +++ b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions-class.md @@ -0,0 +1,128 @@ + + + +# DefaultFirebaseOptions class + + + + + + + + + +

Default FirebaseOptions for use with your Firebase apps.

+

Example:

+
import 'firebase_options.dart';
+// ...
+await Firebase.initializeApp(
+  options: DefaultFirebaseOptions.currentPlatform,
+);
+
+ + + + +## Constructors + +[DefaultFirebaseOptions](../firebase_options/DefaultFirebaseOptions/DefaultFirebaseOptions.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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) + + + +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) + + + +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) + + + +Scaffolds iosFirebaseOptions around FirebaseOptions. + + + + + + + + + + + + diff --git a/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/DefaultFirebaseOptions.md b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/DefaultFirebaseOptions.md new file mode 100644 index 0000000000..b07fd7df28 --- /dev/null +++ b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/DefaultFirebaseOptions.md @@ -0,0 +1,24 @@ + + + +# DefaultFirebaseOptions constructor + + + + + + + +DefaultFirebaseOptions() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md new file mode 100644 index 0000000000..8ca0438042 --- /dev/null +++ b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/android.md @@ -0,0 +1,51 @@ + + + +# android method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +static FirebaseOptions android(Map androidFirebaseOptions) => + FirebaseOptions( + apiKey: androidFirebaseOptions['apiKey'] as String, + appId: androidFirebaseOptions['appId'] as String, + messagingSenderId: + androidFirebaseOptions['messagingSenderId'] as String, + projectId: androidFirebaseOptions['projectId'] as String, + storageBucket: androidFirebaseOptions['storageBucket'] as String, + ); +``` + + + + + + + diff --git a/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md new file mode 100644 index 0000000000..29bbbf15d4 --- /dev/null +++ b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/currentPlatform.md @@ -0,0 +1,72 @@ + + + +# currentPlatform method + + + + + + + + +[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:

+ + + + +## Implementation + +```dart +static FirebaseOptions currentPlatform( + Map androidFirebaseOptions, + Map iosFirebaseOptions, +) { + if (kIsWeb) { + throw UnsupportedError( + 'DefaultFirebaseOptions have not been configured for web - ' + 'you can reconfigure this by running the FlutterFire CLI again.', + ); + } + switch (defaultTargetPlatform) { + case TargetPlatform.android: + return android(androidFirebaseOptions); + case TargetPlatform.iOS: + return ios(iosFirebaseOptions); + case TargetPlatform.macOS: + throw UnsupportedError( + 'DefaultFirebaseOptions have not been configured for macos - ' + 'you can reconfigure this by running the FlutterFire CLI again.', + ); + default: + throw UnsupportedError( + 'DefaultFirebaseOptions are not supported for this platform.', + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/ios.md b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/ios.md new file mode 100644 index 0000000000..e6845082b4 --- /dev/null +++ b/talawa-mobile-docs/firebase_options/DefaultFirebaseOptions/ios.md @@ -0,0 +1,53 @@ + + + +# ios method + + + + + + + + +[FirebaseOptions](https://pub.dev/documentation/firebase_core_platform_interface/4.8.0/firebase_core_platform_interface/FirebaseOptions-class.html) ios +([Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> iosFirebaseOptions) + + + + + +

Scaffolds iosFirebaseOptions around FirebaseOptions.

+

more_info_if_required

+

params:

+
    +
  • iosFirebaseOptions: The options which we want to scaffold
  • +
+

returns:

+
    +
  • FirebaseOptions: Scaffolded FirebaseOptions
  • +
+ + + +## Implementation + +```dart +static FirebaseOptions ios(Map iosFirebaseOptions) => + FirebaseOptions( + apiKey: iosFirebaseOptions['apiKey'] as String, + appId: iosFirebaseOptions['appId'] as String, + messagingSenderId: iosFirebaseOptions['messagingSenderId'] as String, + projectId: iosFirebaseOptions['projectId'] as String, + storageBucket: iosFirebaseOptions['storageBucket'] as String, + iosClientId: iosFirebaseOptions['iosClientId'] as String, + iosBundleId: iosFirebaseOptions['iosBundleId'] as String, + ); +``` + + + + + + + diff --git a/talawa-mobile-docs/firebase_options/firebase_options-library.md b/talawa-mobile-docs/firebase_options/firebase_options-library.md new file mode 100644 index 0000000000..8d7486d184 --- /dev/null +++ b/talawa-mobile-docs/firebase_options/firebase_options-library.md @@ -0,0 +1,38 @@ + + + + +# firebase_options library + + + + + + + + + + + +## Classes + +##### [DefaultFirebaseOptions](../firebase_options/DefaultFirebaseOptions-class.md) + + + +Default FirebaseOptions for use with your Firebase apps. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md b/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md new file mode 100644 index 0000000000..866146259d --- /dev/null +++ b/talawa-mobile-docs/generated_plugin_registrant/generated_plugin_registrant-library.md @@ -0,0 +1,40 @@ + + + + +# generated_plugin_registrant library + + + + + + + + + + + + + + + + +## Functions + +##### [registerPlugins](../generated_plugin_registrant/registerPlugins.md)([Registrar](https://api.flutter.dev/flutter/flutter_web_plugins/Registrar-class.html) registrar) void + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md b/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md new file mode 100644 index 0000000000..0614534bcc --- /dev/null +++ b/talawa-mobile-docs/generated_plugin_registrant/registerPlugins.md @@ -0,0 +1,42 @@ + + + +# registerPlugins function + + + + + + + + + + +void registerPlugins +([Registrar](https://api.flutter.dev/flutter/flutter_web_plugins/Registrar-class.html) registrar) + + + + + + + + +## Implementation + +```dart +void registerPlugins(Registrar registrar) { + ConnectivityPlusPlugin.registerWith(registrar); + SharedPreferencesPlugin.registerWith(registrar); + UniLinksPlugin.registerWith(registrar); + VibrationWebPlugin.registerWith(registrar); + registrar.registerMessageHandler(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/index.json b/talawa-mobile-docs/index.json new file mode 100644 index 0000000000..0ff4d02175 --- /dev/null +++ b/talawa-mobile-docs/index.json @@ -0,0 +1 @@ +[{"name":"access_request_screen","qualifiedName":"access_request_screen","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/views_after_auth_screens_join_org_after_auth_access_request_screen-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SendAccessRequest","qualifiedName":"access_request_screen.SendAccessRequest","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"requestAccess","enclosedBy":{"name":"access_request_screen","type":"library","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/views_after_auth_screens_join_org_after_auth_access_request_screen-library.md"}},{"name":"SendAccessRequest","qualifiedName":"access_request_screen.SendAccessRequest.SendAccessRequest","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SendAccessRequest","type":"class","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md"}},{"name":"build","qualifiedName":"access_request_screen.SendAccessRequest.build","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"SendAccessRequest","type":"class","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md"}},{"name":"org","qualifiedName":"access_request_screen.SendAccessRequest.org","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SendAccessRequest","type":"class","href":"views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md"}},{"name":"access_request_view_model","qualifiedName":"access_request_view_model","href":"view_model_access_request_view_model/view_model_access_request_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AccessScreenViewModel","qualifiedName":"access_request_view_model.AccessScreenViewModel","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"access_request_view_model","type":"library","href":"view_model_access_request_view_model/view_model_access_request_view_model-library.md"}},{"name":"AccessScreenViewModel","qualifiedName":"access_request_view_model.AccessScreenViewModel.AccessScreenViewModel","href":"view_model_access_request_view_model/AccessScreenViewModel/AccessScreenViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"initialise","qualifiedName":"access_request_view_model.AccessScreenViewModel.initialise","href":"view_model_access_request_view_model/AccessScreenViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"optionalMessageController","qualifiedName":"access_request_view_model.AccessScreenViewModel.optionalMessageController","href":"view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"orgId","qualifiedName":"access_request_view_model.AccessScreenViewModel.orgId","href":"view_model_access_request_view_model/AccessScreenViewModel/orgId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"organizations","qualifiedName":"access_request_view_model.AccessScreenViewModel.organizations","href":"view_model_access_request_view_model/AccessScreenViewModel/organizations.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"selectedOrganization","qualifiedName":"access_request_view_model.AccessScreenViewModel.selectedOrganization","href":"view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"sendMembershipRequest","qualifiedName":"access_request_view_model.AccessScreenViewModel.sendMembershipRequest","href":"view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AccessScreenViewModel","type":"class","href":"view_model_access_request_view_model/AccessScreenViewModel-class.md"}},{"name":"add_members_bottom_sheet","qualifiedName":"add_members_bottom_sheet","href":"widgets_add_members_bottom_sheet/widgets_add_members_bottom_sheet-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventBottomSheet","qualifiedName":"add_members_bottom_sheet.EventBottomSheet","href":"widgets_add_members_bottom_sheet/EventBottomSheet-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Adds members to an event.","enclosedBy":{"name":"add_members_bottom_sheet","type":"library","href":"widgets_add_members_bottom_sheet/widgets_add_members_bottom_sheet-library.md"}},{"name":"EventBottomSheet","qualifiedName":"add_members_bottom_sheet.EventBottomSheet.EventBottomSheet","href":"widgets_add_members_bottom_sheet/EventBottomSheet/EventBottomSheet.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventBottomSheet","type":"class","href":"widgets_add_members_bottom_sheet/EventBottomSheet-class.md"}},{"name":"addUserBottomSheet","qualifiedName":"add_members_bottom_sheet.EventBottomSheet.addUserBottomSheet","href":"widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function creates a modal material design bottom sheet.","enclosedBy":{"name":"EventBottomSheet","type":"class","href":"widgets_add_members_bottom_sheet/EventBottomSheet-class.md"}},{"name":"add_post_page","qualifiedName":"add_post_page","href":"views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AddPost","qualifiedName":"add_post_page.AddPost","href":"views_after_auth_screens_add_post_page/AddPost-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"AddPost returns a widget to add(upload) the post.","enclosedBy":{"name":"add_post_page","type":"library","href":"views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md"}},{"name":"AddPost","qualifiedName":"add_post_page.AddPost.AddPost","href":"views_after_auth_screens_add_post_page/AddPost/AddPost.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AddPost","type":"class","href":"views_after_auth_screens_add_post_page/AddPost-class.md"}},{"name":"build","qualifiedName":"add_post_page.AddPost.build","href":"views_after_auth_screens_add_post_page/AddPost/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"AddPost","type":"class","href":"views_after_auth_screens_add_post_page/AddPost-class.md"}},{"name":"drawerKey","qualifiedName":"add_post_page.AddPost.drawerKey","href":"views_after_auth_screens_add_post_page/AddPost/drawerKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"DrawerKey.","enclosedBy":{"name":"AddPost","type":"class","href":"views_after_auth_screens_add_post_page/AddPost-class.md"}},{"name":"model","qualifiedName":"add_post_page.model","href":"views_after_auth_screens_add_post_page/model.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"Add Post View Model.","enclosedBy":{"name":"add_post_page","type":"library","href":"views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md"}},{"name":"add_post_view_model","qualifiedName":"add_post_view_model","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/view_model_after_auth_view_models_add_post_view_models_add_post_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AddPostViewModel","qualifiedName":"add_post_view_model.AddPostViewModel","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"AddPostViewModel class have different functions that are used.","enclosedBy":{"name":"add_post_view_model","type":"library","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/view_model_after_auth_view_models_add_post_view_models_add_post_view_model-library.md"}},{"name":"AddPostViewModel","qualifiedName":"add_post_view_model.AddPostViewModel.AddPostViewModel","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/AddPostViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"controller","qualifiedName":"add_post_view_model.AddPostViewModel.controller","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Post body text controller.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"getImageFromGallery","qualifiedName":"add_post_view_model.AddPostViewModel.getImageFromGallery","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get the image from gallery.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"imageFile","qualifiedName":"add_post_view_model.AddPostViewModel.imageFile","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"The image file that is to be uploaded.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"initialise","qualifiedName":"add_post_view_model.AddPostViewModel.initialise","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is usedto do initialisation of stuff in the view model.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"orgName","qualifiedName":"add_post_view_model.AddPostViewModel.orgName","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"The organisation name.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"removeImage","qualifiedName":"add_post_view_model.AddPostViewModel.removeImage","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function removes the image selected.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"titleController","qualifiedName":"add_post_view_model.AddPostViewModel.titleController","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Post title text controller.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"uploadPost","qualifiedName":"add_post_view_model.AddPostViewModel.uploadPost","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function uploads the post finally, and navigate the success message or error message in Snack Bar.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"userName","qualifiedName":"add_post_view_model.AddPostViewModel.userName","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"The Username.","enclosedBy":{"name":"AddPostViewModel","type":"class","href":"view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md"}},{"name":"app_localization","qualifiedName":"app_localization","href":"utils_app_localization/utils_app_localization-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AppLocalizations","qualifiedName":"app_localization.AppLocalizations","href":"utils_app_localization/AppLocalizations-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class provides methods to localize the application so that it can be available\nto users with different languages.","enclosedBy":{"name":"app_localization","type":"library","href":"utils_app_localization/utils_app_localization-library.md"}},{"name":"AppLocalizations","qualifiedName":"app_localization.AppLocalizations.AppLocalizations","href":"utils_app_localization/AppLocalizations/AppLocalizations.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"delegate","qualifiedName":"app_localization.AppLocalizations.delegate","href":"utils_app_localization/AppLocalizations/delegate-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"isTest","qualifiedName":"app_localization.AppLocalizations.isTest","href":"utils_app_localization/AppLocalizations/isTest.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"load","qualifiedName":"app_localization.AppLocalizations.load","href":"utils_app_localization/AppLocalizations/load.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"loadTest","qualifiedName":"app_localization.AppLocalizations.loadTest","href":"utils_app_localization/AppLocalizations/loadTest.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"locale","qualifiedName":"app_localization.AppLocalizations.locale","href":"utils_app_localization/AppLocalizations/locale.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"of","qualifiedName":"app_localization.AppLocalizations.of","href":"utils_app_localization/AppLocalizations/of.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"strictTranslate","qualifiedName":"app_localization.AppLocalizations.strictTranslate","href":"utils_app_localization/AppLocalizations/strictTranslate.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"translate","qualifiedName":"app_localization.AppLocalizations.translate","href":"utils_app_localization/AppLocalizations/translate.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizations","type":"class","href":"utils_app_localization/AppLocalizations-class.md"}},{"name":"AppLocalizationsDelegate","qualifiedName":"app_localization.AppLocalizationsDelegate","href":"utils_app_localization/AppLocalizationsDelegate-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"app_localization","type":"library","href":"utils_app_localization/utils_app_localization-library.md"}},{"name":"AppLocalizationsDelegate","qualifiedName":"app_localization.AppLocalizationsDelegate.AppLocalizationsDelegate","href":"utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizationsDelegate","type":"class","href":"utils_app_localization/AppLocalizationsDelegate-class.md"}},{"name":"isSupported","qualifiedName":"app_localization.AppLocalizationsDelegate.isSupported","href":"utils_app_localization/AppLocalizationsDelegate/isSupported.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Whether resources for the given locale can be loaded by this delegate.","enclosedBy":{"name":"AppLocalizationsDelegate","type":"class","href":"utils_app_localization/AppLocalizationsDelegate-class.md"}},{"name":"isTest","qualifiedName":"app_localization.AppLocalizationsDelegate.isTest","href":"utils_app_localization/AppLocalizationsDelegate/isTest.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLocalizationsDelegate","type":"class","href":"utils_app_localization/AppLocalizationsDelegate-class.md"}},{"name":"load","qualifiedName":"app_localization.AppLocalizationsDelegate.load","href":"utils_app_localization/AppLocalizationsDelegate/load.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Start loading the resources for locale. The returned future completes\nwhen the resources have finished loading.","enclosedBy":{"name":"AppLocalizationsDelegate","type":"class","href":"utils_app_localization/AppLocalizationsDelegate-class.md"}},{"name":"shouldReload","qualifiedName":"app_localization.AppLocalizationsDelegate.shouldReload","href":"utils_app_localization/AppLocalizationsDelegate/shouldReload.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Returns true if the resources for this delegate should be loaded\nagain by calling the load method.","enclosedBy":{"name":"AppLocalizationsDelegate","type":"class","href":"utils_app_localization/AppLocalizationsDelegate-class.md"}},{"name":"app_settings_page","qualifiedName":"app_settings_page","href":"views_after_auth_screens_app_settings_app_settings_page/views_after_auth_screens_app_settings_app_settings_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AppSettingsPage","qualifiedName":"app_settings_page.AppSettingsPage","href":"views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"AppSettingsPage is a widget that has mutable state _AppSettingsPageState.","enclosedBy":{"name":"app_settings_page","type":"library","href":"views_after_auth_screens_app_settings_app_settings_page/views_after_auth_screens_app_settings_app_settings_page-library.md"}},{"name":"AppSettingsPage","qualifiedName":"app_settings_page.AppSettingsPage.AppSettingsPage","href":"views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppSettingsPage","type":"class","href":"views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md"}},{"name":"createState","qualifiedName":"app_settings_page.AppSettingsPage.createState","href":"views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"AppSettingsPage","type":"class","href":"views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md"}},{"name":"apptheme","qualifiedName":"apptheme","href":"apptheme/apptheme-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AppTheme","qualifiedName":"apptheme.AppTheme","href":"apptheme/AppTheme-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"apptheme","type":"library","href":"apptheme/apptheme-library.md"}},{"name":"AppTheme","qualifiedName":"apptheme.AppTheme.AppTheme","href":"apptheme/AppTheme/AppTheme.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"blackPrimary","qualifiedName":"apptheme.AppTheme.blackPrimary","href":"apptheme/AppTheme/blackPrimary-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"blackSecondary","qualifiedName":"apptheme.AppTheme.blackSecondary","href":"apptheme/AppTheme/blackSecondary-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"blackTertiary","qualifiedName":"apptheme.AppTheme.blackTertiary","href":"apptheme/AppTheme/blackTertiary-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"blue","qualifiedName":"apptheme.AppTheme.blue","href":"apptheme/AppTheme/blue-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"bodyText1","qualifiedName":"apptheme.AppTheme.bodyText1","href":"apptheme/AppTheme/bodyText1.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"bodyText2","qualifiedName":"apptheme.AppTheme.bodyText2","href":"apptheme/AppTheme/bodyText2.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"bodyText3","qualifiedName":"apptheme.AppTheme.bodyText3","href":"apptheme/AppTheme/bodyText3.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"button","qualifiedName":"apptheme.AppTheme.button","href":"apptheme/AppTheme/button.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"green","qualifiedName":"apptheme.AppTheme.green","href":"apptheme/AppTheme/green-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"grey","qualifiedName":"apptheme.AppTheme.grey","href":"apptheme/AppTheme/grey-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"headline1","qualifiedName":"apptheme.AppTheme.headline1","href":"apptheme/AppTheme/headline1.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"headline2","qualifiedName":"apptheme.AppTheme.headline2","href":"apptheme/AppTheme/headline2.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"headline3","qualifiedName":"apptheme.AppTheme.headline3","href":"apptheme/AppTheme/headline3.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"headline4","qualifiedName":"apptheme.AppTheme.headline4","href":"apptheme/AppTheme/headline4.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"headline5","qualifiedName":"apptheme.AppTheme.headline5","href":"apptheme/AppTheme/headline5.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"headline6","qualifiedName":"apptheme.AppTheme.headline6","href":"apptheme/AppTheme/headline6.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"lightGrey","qualifiedName":"apptheme.AppTheme.lightGrey","href":"apptheme/AppTheme/lightGrey-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"overline","qualifiedName":"apptheme.AppTheme.overline","href":"apptheme/AppTheme/overline.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"primary","qualifiedName":"apptheme.AppTheme.primary","href":"apptheme/AppTheme/primary-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"red","qualifiedName":"apptheme.AppTheme.red","href":"apptheme/AppTheme/red-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"secondary","qualifiedName":"apptheme.AppTheme.secondary","href":"apptheme/AppTheme/secondary-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"shadow","qualifiedName":"apptheme.AppTheme.shadow","href":"apptheme/AppTheme/shadow-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"subtitle1","qualifiedName":"apptheme.AppTheme.subtitle1","href":"apptheme/AppTheme/subtitle1.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"subtitle2","qualifiedName":"apptheme.AppTheme.subtitle2","href":"apptheme/AppTheme/subtitle2.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"tertiary","qualifiedName":"apptheme.AppTheme.tertiary","href":"apptheme/AppTheme/tertiary-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"title","qualifiedName":"apptheme.AppTheme.title","href":"apptheme/AppTheme/title.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"white","qualifiedName":"apptheme.AppTheme.white","href":"apptheme/AppTheme/white-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"yellow","qualifiedName":"apptheme.AppTheme.yellow","href":"apptheme/AppTheme/yellow-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"apptheme/AppTheme-class.md"}},{"name":"base_view","qualifiedName":"base_view","href":"views_base_view/views_base_view-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"BaseView","qualifiedName":"base_view.BaseView","href":"views_base_view/BaseView-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"base_view","type":"library","href":"views_base_view/views_base_view-library.md"}},{"name":"BaseView","qualifiedName":"base_view.BaseView.BaseView","href":"views_base_view/BaseView/BaseView.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseView","type":"class","href":"views_base_view/BaseView-class.md"}},{"name":"builder","qualifiedName":"base_view.BaseView.builder","href":"views_base_view/BaseView/builder.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseView","type":"class","href":"views_base_view/BaseView-class.md"}},{"name":"createState","qualifiedName":"base_view.BaseView.createState","href":"views_base_view/BaseView/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"BaseView","type":"class","href":"views_base_view/BaseView-class.md"}},{"name":"onModelReady","qualifiedName":"base_view.BaseView.onModelReady","href":"views_base_view/BaseView/onModelReady.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseView","type":"class","href":"views_base_view/BaseView-class.md"}},{"name":"base_view_model","qualifiedName":"base_view_model","href":"view_model_base_view_model/view_model_base_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"BaseModel","qualifiedName":"base_view_model.BaseModel","href":"view_model_base_view_model/BaseModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"base_view_model","type":"library","href":"view_model_base_view_model/view_model_base_view_model-library.md"}},{"name":"BaseModel","qualifiedName":"base_view_model.BaseModel.BaseModel","href":"view_model_base_view_model/BaseModel/BaseModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseModel","type":"class","href":"view_model_base_view_model/BaseModel-class.md"}},{"name":"isBusy","qualifiedName":"base_view_model.BaseModel.isBusy","href":"view_model_base_view_model/BaseModel/isBusy.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseModel","type":"class","href":"view_model_base_view_model/BaseModel-class.md"}},{"name":"setState","qualifiedName":"base_view_model.BaseModel.setState","href":"view_model_base_view_model/BaseModel/setState.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseModel","type":"class","href":"view_model_base_view_model/BaseModel-class.md"}},{"name":"state","qualifiedName":"base_view_model.BaseModel.state","href":"view_model_base_view_model/BaseModel/state.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"BaseModel","type":"class","href":"view_model_base_view_model/BaseModel-class.md"}},{"name":"change_password","qualifiedName":"change_password","href":"views_pre_auth_screens_change_password/views_pre_auth_screens_change_password-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChangePass","qualifiedName":"change_password.ChangePass","href":"views_pre_auth_screens_change_password/ChangePass-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget lets the user change his/her password.\nThere are two input fields. The first one is for entering the new password, and the\nsecond one is for re-entering the password for verification.\nThere is a raised button which finally updates the password when pressed.","enclosedBy":{"name":"change_password","type":"library","href":"views_pre_auth_screens_change_password/views_pre_auth_screens_change_password-library.md"}},{"name":"ChangePass","qualifiedName":"change_password.ChangePass.ChangePass","href":"views_pre_auth_screens_change_password/ChangePass/ChangePass.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChangePass","type":"class","href":"views_pre_auth_screens_change_password/ChangePass-class.md"}},{"name":"createState","qualifiedName":"change_password.ChangePass.createState","href":"views_pre_auth_screens_change_password/ChangePass/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"ChangePass","type":"class","href":"views_pre_auth_screens_change_password/ChangePass-class.md"}},{"name":"chat_input_field","qualifiedName":"chat_input_field","href":"views_after_auth_screens_chat_widgets_chat_input_field/views_after_auth_screens_chat_widgets_chat_input_field-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatInputField","qualifiedName":"chat_input_field.ChatInputField","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ChatInputField returns a widget that has mutable state _ChatInputFieldState.","enclosedBy":{"name":"chat_input_field","type":"library","href":"views_after_auth_screens_chat_widgets_chat_input_field/views_after_auth_screens_chat_widgets_chat_input_field-library.md"}},{"name":"ChatInputField","qualifiedName":"chat_input_field.ChatInputField.ChatInputField","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatInputField","type":"class","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md"}},{"name":"chatId","qualifiedName":"chat_input_field.ChatInputField.chatId","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"ChatId.","enclosedBy":{"name":"ChatInputField","type":"class","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md"}},{"name":"createState","qualifiedName":"chat_input_field.ChatInputField.createState","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"ChatInputField","type":"class","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md"}},{"name":"model","qualifiedName":"chat_input_field.ChatInputField.model","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"DirectChatViewModel instance.","enclosedBy":{"name":"ChatInputField","type":"class","href":"views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md"}},{"name":"chat_list_screen","qualifiedName":"chat_list_screen","href":"views_after_auth_screens_chat_chat_list_screen/views_after_auth_screens_chat_chat_list_screen-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatPage","qualifiedName":"chat_list_screen.ChatPage","href":"views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ChatPage returns a stateless widget for current user Chat Page which renders\nthe list of all the users that the current user has chat with.","enclosedBy":{"name":"chat_list_screen","type":"library","href":"views_after_auth_screens_chat_chat_list_screen/views_after_auth_screens_chat_chat_list_screen-library.md"}},{"name":"ChatPage","qualifiedName":"chat_list_screen.ChatPage.ChatPage","href":"views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatPage","type":"class","href":"views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md"}},{"name":"build","qualifiedName":"chat_list_screen.ChatPage.build","href":"views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"ChatPage","type":"class","href":"views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md"}},{"name":"chat_list_tile_data_model","qualifiedName":"chat_list_tile_data_model","href":"models_chats_chat_list_tile_data_model/models_chats_chat_list_tile_data_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatListTileDataModel","qualifiedName":"chat_list_tile_data_model.ChatListTileDataModel","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates JSON code using the JsonSerializable package.","enclosedBy":{"name":"chat_list_tile_data_model","type":"library","href":"models_chats_chat_list_tile_data_model/models_chats_chat_list_tile_data_model-library.md"}},{"name":"ChatListTileDataModel","qualifiedName":"chat_list_tile_data_model.ChatListTileDataModel.ChatListTileDataModel","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatListTileDataModel","type":"class","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md"}},{"name":"ChatListTileDataModel.fromJson","qualifiedName":"chat_list_tile_data_model.ChatListTileDataModel.fromJson","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatListTileDataModel","type":"class","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md"}},{"name":"id","qualifiedName":"chat_list_tile_data_model.ChatListTileDataModel.id","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatListTileDataModel","type":"class","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md"}},{"name":"toJson","qualifiedName":"chat_list_tile_data_model.ChatListTileDataModel.toJson","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatListTileDataModel","type":"class","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md"}},{"name":"users","qualifiedName":"chat_list_tile_data_model.ChatListTileDataModel.users","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatListTileDataModel","type":"class","href":"models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md"}},{"name":"chat_message","qualifiedName":"chat_message","href":"models_chats_chat_message/models_chats_chat_message-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatMessage","qualifiedName":"chat_message.ChatMessage","href":"models_chats_chat_message/ChatMessage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates JSON code for chat message using the JsonSerializable package.","enclosedBy":{"name":"chat_message","type":"library","href":"models_chats_chat_message/models_chats_chat_message-library.md"}},{"name":"ChatMessage","qualifiedName":"chat_message.ChatMessage.ChatMessage","href":"models_chats_chat_message/ChatMessage/ChatMessage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"ChatMessage.fromJson","qualifiedName":"chat_message.ChatMessage.fromJson","href":"models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"id","qualifiedName":"chat_message.ChatMessage.id","href":"models_chats_chat_message/ChatMessage/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"messageContent","qualifiedName":"chat_message.ChatMessage.messageContent","href":"models_chats_chat_message/ChatMessage/messageContent.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"receiver","qualifiedName":"chat_message.ChatMessage.receiver","href":"models_chats_chat_message/ChatMessage/receiver.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"sender","qualifiedName":"chat_message.ChatMessage.sender","href":"models_chats_chat_message/ChatMessage/sender.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"toJson","qualifiedName":"chat_message.ChatMessage.toJson","href":"models_chats_chat_message/ChatMessage/toJson.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessage","type":"class","href":"models_chats_chat_message/ChatMessage-class.md"}},{"name":"chat_message_bubble","qualifiedName":"chat_message_bubble","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/views_after_auth_screens_chat_widgets_chat_message_bubble-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Message","qualifiedName":"chat_message_bubble.Message","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Message returns a widget for chat message in the bubble form.","enclosedBy":{"name":"chat_message_bubble","type":"library","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/views_after_auth_screens_chat_widgets_chat_message_bubble-library.md"}},{"name":"Message","qualifiedName":"chat_message_bubble.Message.Message","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Message","type":"class","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md"}},{"name":"build","qualifiedName":"chat_message_bubble.Message.build","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"Message","type":"class","href":"views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md"}},{"name":"chat_message_screen","qualifiedName":"chat_message_screen","href":"views_after_auth_screens_chat_chat_message_screen/views_after_auth_screens_chat_chat_message_screen-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatMessageScreen","qualifiedName":"chat_message_screen.ChatMessageScreen","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ChatMessageScreen returns a StatelessWidget for showing the chat message screen.","enclosedBy":{"name":"chat_message_screen","type":"library","href":"views_after_auth_screens_chat_chat_message_screen/views_after_auth_screens_chat_chat_message_screen-library.md"}},{"name":"ChatMessageScreen","qualifiedName":"chat_message_screen.ChatMessageScreen.ChatMessageScreen","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessageScreen","type":"class","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md"}},{"name":"build","qualifiedName":"chat_message_screen.ChatMessageScreen.build","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"ChatMessageScreen","type":"class","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md"}},{"name":"chatId","qualifiedName":"chat_message_screen.ChatMessageScreen.chatId","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessageScreen","type":"class","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md"}},{"name":"model","qualifiedName":"chat_message_screen.ChatMessageScreen.model","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatMessageScreen","type":"class","href":"views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md"}},{"name":"chat_queries","qualifiedName":"chat_queries","href":"utils_chat_queries/utils_chat_queries-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatQueries","qualifiedName":"chat_queries.ChatQueries","href":"utils_chat_queries/ChatQueries-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates the queries dealing with chats.","enclosedBy":{"name":"chat_queries","type":"library","href":"utils_chat_queries/utils_chat_queries-library.md"}},{"name":"ChatQueries","qualifiedName":"chat_queries.ChatQueries.ChatQueries","href":"utils_chat_queries/ChatQueries/ChatQueries.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatQueries","type":"class","href":"utils_chat_queries/ChatQueries-class.md"}},{"name":"fetchDirectChatMessagesByChatId","qualifiedName":"chat_queries.ChatQueries.fetchDirectChatMessagesByChatId","href":"utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatQueries","type":"class","href":"utils_chat_queries/ChatQueries-class.md"}},{"name":"fetchDirectChatsByUserId","qualifiedName":"chat_queries.ChatQueries.fetchDirectChatsByUserId","href":"utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatQueries","type":"class","href":"utils_chat_queries/ChatQueries-class.md"}},{"name":"messageSentToDirectChatsubscription","qualifiedName":"chat_queries.ChatQueries.messageSentToDirectChatsubscription","href":"utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatQueries","type":"class","href":"utils_chat_queries/ChatQueries-class.md"}},{"name":"sendMessageToDirectChat","qualifiedName":"chat_queries.ChatQueries.sendMessageToDirectChat","href":"utils_chat_queries/ChatQueries/sendMessageToDirectChat.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatQueries","type":"class","href":"utils_chat_queries/ChatQueries-class.md"}},{"name":"chat_service","qualifiedName":"chat_service","href":"services_chat_service/services_chat_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatService","qualifiedName":"chat_service.ChatService","href":"services_chat_service/ChatService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ChatService class provides different services for direct chats of the user.","enclosedBy":{"name":"chat_service","type":"library","href":"services_chat_service/services_chat_service-library.md"}},{"name":"ChatService","qualifiedName":"chat_service.ChatService.ChatService","href":"services_chat_service/ChatService/ChatService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"chatListStream","qualifiedName":"chat_service.ChatService.chatListStream","href":"services_chat_service/ChatService/chatListStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"chatMessagesStream","qualifiedName":"chat_service.ChatService.chatMessagesStream","href":"services_chat_service/ChatService/chatMessagesStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"chatStream","qualifiedName":"chat_service.ChatService.chatStream","href":"services_chat_service/ChatService/chatStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"getDirectChatMessagesByChatId","qualifiedName":"chat_service.ChatService.getDirectChatMessagesByChatId","href":"services_chat_service/ChatService/getDirectChatMessagesByChatId.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get all the chat messages of a particular chat by the user.","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"getDirectChatsByUserId","qualifiedName":"chat_service.ChatService.getDirectChatsByUserId","href":"services_chat_service/ChatService/getDirectChatsByUserId.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get all the chats by the user.","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"sendMessageToDirectChat","qualifiedName":"chat_service.ChatService.sendMessageToDirectChat","href":"services_chat_service/ChatService/sendMessageToDirectChat.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to send the message in the direct chats.","enclosedBy":{"name":"ChatService","type":"class","href":"services_chat_service/ChatService-class.md"}},{"name":"chat_user","qualifiedName":"chat_user","href":"models_chats_chat_user/models_chats_chat_user-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatUser","qualifiedName":"chat_user.ChatUser","href":"models_chats_chat_user/ChatUser-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates JSON code for chat user using the JsonSerializable package.","enclosedBy":{"name":"chat_user","type":"library","href":"models_chats_chat_user/models_chats_chat_user-library.md"}},{"name":"ChatUser","qualifiedName":"chat_user.ChatUser.ChatUser","href":"models_chats_chat_user/ChatUser/ChatUser.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatUser","type":"class","href":"models_chats_chat_user/ChatUser-class.md"}},{"name":"firstName","qualifiedName":"chat_user.ChatUser.firstName","href":"models_chats_chat_user/ChatUser/firstName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatUser","type":"class","href":"models_chats_chat_user/ChatUser-class.md"}},{"name":"ChatUser.fromJson","qualifiedName":"chat_user.ChatUser.fromJson","href":"models_chats_chat_user/ChatUser/ChatUser.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatUser","type":"class","href":"models_chats_chat_user/ChatUser-class.md"}},{"name":"id","qualifiedName":"chat_user.ChatUser.id","href":"models_chats_chat_user/ChatUser/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatUser","type":"class","href":"models_chats_chat_user/ChatUser-class.md"}},{"name":"image","qualifiedName":"chat_user.ChatUser.image","href":"models_chats_chat_user/ChatUser/image.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatUser","type":"class","href":"models_chats_chat_user/ChatUser-class.md"}},{"name":"toJson","qualifiedName":"chat_user.ChatUser.toJson","href":"models_chats_chat_user/ChatUser/toJson.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatUser","type":"class","href":"models_chats_chat_user/ChatUser-class.md"}},{"name":"comment_model","qualifiedName":"comment_model","href":"models_comment_comment_model/models_comment_comment_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Comment","qualifiedName":"comment_model.Comment","href":"models_comment_comment_model/Comment-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns a Comment instance.","enclosedBy":{"name":"comment_model","type":"library","href":"models_comment_comment_model/models_comment_comment_model-library.md"}},{"name":"Comment","qualifiedName":"comment_model.Comment.Comment","href":"models_comment_comment_model/Comment/Comment.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"createdAt","qualifiedName":"comment_model.Comment.createdAt","href":"models_comment_comment_model/Comment/createdAt.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"creator","qualifiedName":"comment_model.Comment.creator","href":"models_comment_comment_model/Comment/creator.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"Comment.fromJson","qualifiedName":"comment_model.Comment.fromJson","href":"models_comment_comment_model/Comment/Comment.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"likeCount","qualifiedName":"comment_model.Comment.likeCount","href":"models_comment_comment_model/Comment/likeCount.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"post","qualifiedName":"comment_model.Comment.post","href":"models_comment_comment_model/Comment/post.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"text","qualifiedName":"comment_model.Comment.text","href":"models_comment_comment_model/Comment/text.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comment","type":"class","href":"models_comment_comment_model/Comment-class.md"}},{"name":"comment_queries","qualifiedName":"comment_queries","href":"utils_comment_queries/utils_comment_queries-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CommentQueries","qualifiedName":"comment_queries.CommentQueries","href":"utils_comment_queries/CommentQueries-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates the queries dealing with comments.","enclosedBy":{"name":"comment_queries","type":"library","href":"utils_comment_queries/utils_comment_queries-library.md"}},{"name":"CommentQueries","qualifiedName":"comment_queries.CommentQueries.CommentQueries","href":"utils_comment_queries/CommentQueries/CommentQueries.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentQueries","type":"class","href":"utils_comment_queries/CommentQueries-class.md"}},{"name":"createComment","qualifiedName":"comment_queries.CommentQueries.createComment","href":"utils_comment_queries/CommentQueries/createComment.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentQueries","type":"class","href":"utils_comment_queries/CommentQueries-class.md"}},{"name":"getPostsComments","qualifiedName":"comment_queries.CommentQueries.getPostsComments","href":"utils_comment_queries/CommentQueries/getPostsComments.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentQueries","type":"class","href":"utils_comment_queries/CommentQueries-class.md"}},{"name":"comment_service","qualifiedName":"comment_service","href":"services_comment_service/services_comment_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CommentService","qualifiedName":"comment_service.CommentService","href":"services_comment_service/CommentService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CommentService class have different member functions which provides service in the context of commenting.","enclosedBy":{"name":"comment_service","type":"library","href":"services_comment_service/services_comment_service-library.md"}},{"name":"CommentService","qualifiedName":"comment_service.CommentService.CommentService","href":"services_comment_service/CommentService/CommentService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentService","type":"class","href":"services_comment_service/CommentService-class.md"}},{"name":"createComments","qualifiedName":"comment_service.CommentService.createComments","href":"services_comment_service/CommentService/createComments.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to add comment on the post.","enclosedBy":{"name":"CommentService","type":"class","href":"services_comment_service/CommentService-class.md"}},{"name":"getCommentsForPost","qualifiedName":"comment_service.CommentService.getCommentsForPost","href":"services_comment_service/CommentService/getCommentsForPost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to fetch all comments on the post.","enclosedBy":{"name":"CommentService","type":"class","href":"services_comment_service/CommentService-class.md"}},{"name":"comments_view_model","qualifiedName":"comments_view_model","href":"view_model_widgets_view_models_comments_view_model/view_model_widgets_view_models_comments_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CommentsViewModel","qualifiedName":"comments_view_model.CommentsViewModel","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CommentsViewModel class helps to serve the data from model\nand to react to user's input for Comment Widget.","enclosedBy":{"name":"comments_view_model","type":"library","href":"view_model_widgets_view_models_comments_view_model/view_model_widgets_view_models_comments_view_model-library.md"}},{"name":"CommentsViewModel","qualifiedName":"comments_view_model.CommentsViewModel.CommentsViewModel","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/CommentsViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"addCommentLocally","qualifiedName":"comments_view_model.CommentsViewModel.addCommentLocally","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"commentList","qualifiedName":"comments_view_model.CommentsViewModel.commentList","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"createComment","qualifiedName":"comments_view_model.CommentsViewModel.createComment","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function add comment on the post.\nThe function uses createComments method provided by Comment Service.","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"getComments","qualifiedName":"comments_view_model.CommentsViewModel.getComments","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This methods fetch all comments on the post.\nThe function uses getCommentsForPost method by Comment Service.","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"initialise","qualifiedName":"comments_view_model.CommentsViewModel.initialise","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"postId","qualifiedName":"comments_view_model.CommentsViewModel.postId","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentsViewModel","type":"class","href":"view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md"}},{"name":"constants","qualifiedName":"constants","href":"constants_constants/constants_constants-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"languages","qualifiedName":"constants.languages","href":"constants_constants/languages.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"This file contains the prototypes of all the languages available and supported currencies.","enclosedBy":{"name":"constants","type":"library","href":"constants_constants/constants_constants-library.md"}},{"name":"supportedCurrencies","qualifiedName":"constants.supportedCurrencies","href":"constants_constants/supportedCurrencies.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"constants","type":"library","href":"constants_constants/constants_constants-library.md"}},{"name":"create_event_form","qualifiedName":"create_event_form","href":"views_after_auth_screens_events_create_event_form/views_after_auth_screens_events_create_event_form-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CreateEventForm","qualifiedName":"create_event_form.CreateEventForm","href":"views_after_auth_screens_events_create_event_form/CreateEventForm-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CreateEventForm returns a widget of a Form for creating events in the organization.\nThis widget is used in CreateEventPage widget.","enclosedBy":{"name":"create_event_form","type":"library","href":"views_after_auth_screens_events_create_event_form/views_after_auth_screens_events_create_event_form-library.md"}},{"name":"CreateEventForm","qualifiedName":"create_event_form.CreateEventForm.CreateEventForm","href":"views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateEventForm","type":"class","href":"views_after_auth_screens_events_create_event_form/CreateEventForm-class.md"}},{"name":"build","qualifiedName":"create_event_form.CreateEventForm.build","href":"views_after_auth_screens_events_create_event_form/CreateEventForm/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CreateEventForm","type":"class","href":"views_after_auth_screens_events_create_event_form/CreateEventForm-class.md"}},{"name":"model","qualifiedName":"create_event_form.CreateEventForm.model","href":"views_after_auth_screens_events_create_event_form/CreateEventForm/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateEventForm","type":"class","href":"views_after_auth_screens_events_create_event_form/CreateEventForm-class.md"}},{"name":"create_event_page","qualifiedName":"create_event_page","href":"views_after_auth_screens_events_create_event_page/views_after_auth_screens_events_create_event_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CreateEventPage","qualifiedName":"create_event_page.CreateEventPage","href":"views_after_auth_screens_events_create_event_page/CreateEventPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CreateEventPage returns a widget that has mutable state _CreateEventPageState.","enclosedBy":{"name":"create_event_page","type":"library","href":"views_after_auth_screens_events_create_event_page/views_after_auth_screens_events_create_event_page-library.md"}},{"name":"CreateEventPage","qualifiedName":"create_event_page.CreateEventPage.CreateEventPage","href":"views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateEventPage","type":"class","href":"views_after_auth_screens_events_create_event_page/CreateEventPage-class.md"}},{"name":"createState","qualifiedName":"create_event_page.CreateEventPage.createState","href":"views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"CreateEventPage","type":"class","href":"views_after_auth_screens_events_create_event_page/CreateEventPage-class.md"}},{"name":"create_event_view_model","qualifiedName":"create_event_view_model","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/view_model_after_auth_view_models_event_view_models_create_event_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CreateEventViewModel","qualifiedName":"create_event_view_model.CreateEventViewModel","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CreateEventViewModel class have methods to interact with model in.","enclosedBy":{"name":"create_event_view_model","type":"library","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/view_model_after_auth_view_models_event_view_models_create_event_view_model-library.md"}},{"name":"CreateEventViewModel","qualifiedName":"create_event_view_model.CreateEventViewModel.CreateEventViewModel","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/CreateEventViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"buildUserList","qualifiedName":"create_event_view_model.CreateEventViewModel.buildUserList","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function build the user list.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"createEvent","qualifiedName":"create_event_view_model.CreateEventViewModel.createEvent","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to create the event for the organization.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"descriptionFocus","qualifiedName":"create_event_view_model.CreateEventViewModel.descriptionFocus","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"DescriptionFocus FocusNode.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventDescriptionTextController","qualifiedName":"create_event_view_model.CreateEventViewModel.eventDescriptionTextController","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event Description Text Controller.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventEndDate","qualifiedName":"create_event_view_model.CreateEventViewModel.eventEndDate","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event End Date.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventEndTime","qualifiedName":"create_event_view_model.CreateEventViewModel.eventEndTime","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event End Time.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventLocationTextController","qualifiedName":"create_event_view_model.CreateEventViewModel.eventLocationTextController","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event Location Text Controller.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventStartDate","qualifiedName":"create_event_view_model.CreateEventViewModel.eventStartDate","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event Start Date.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventStartTime","qualifiedName":"create_event_view_model.CreateEventViewModel.eventStartTime","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event Start Time.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"eventTitleTextController","qualifiedName":"create_event_view_model.CreateEventViewModel.eventTitleTextController","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Event Title Text Controller.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"formKey","qualifiedName":"create_event_view_model.CreateEventViewModel.formKey","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Global FormKey.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"getCurrentOrgUsersList","qualifiedName":"create_event_view_model.CreateEventViewModel.getCurrentOrgUsersList","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch all the users in the current organization and return List.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"getImageFromGallery","qualifiedName":"create_event_view_model.CreateEventViewModel.getImageFromGallery","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get the image from gallery.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"imageFile","qualifiedName":"create_event_view_model.CreateEventViewModel.imageFile","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Getter to return imageFile.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"initialize","qualifiedName":"create_event_view_model.CreateEventViewModel.initialize","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Function To Initialize.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"isPublicSwitch","qualifiedName":"create_event_view_model.CreateEventViewModel.isPublicSwitch","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Public Event or Not.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"isRegisterableSwitch","qualifiedName":"create_event_view_model.CreateEventViewModel.isRegisterableSwitch","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"If event is registerable after creation.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"latitude","qualifiedName":"create_event_view_model.CreateEventViewModel.latitude","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Latitude store.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"locationFocus","qualifiedName":"create_event_view_model.CreateEventViewModel.locationFocus","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"LocationFocus FocusNode.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"longitude","qualifiedName":"create_event_view_model.CreateEventViewModel.longitude","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Longitude store.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"memberCheckedMap","qualifiedName":"create_event_view_model.CreateEventViewModel.memberCheckedMap","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Getter to return members map.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"orgMembersList","qualifiedName":"create_event_view_model.CreateEventViewModel.orgMembersList","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Organisation Members List.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"removeImage","qualifiedName":"create_event_view_model.CreateEventViewModel.removeImage","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function remove the selected image.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"removeUserFromList","qualifiedName":"create_event_view_model.CreateEventViewModel.removeUserFromList","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to remove a user from user's list.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"selectedMembers","qualifiedName":"create_event_view_model.CreateEventViewModel.selectedMembers","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Getter to return selected members.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"titleFocus","qualifiedName":"create_event_view_model.CreateEventViewModel.titleFocus","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"TitleFocus FocusNode.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"validate","qualifiedName":"create_event_view_model.CreateEventViewModel.validate","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"AutoValidateMode default to disabled.","enclosedBy":{"name":"CreateEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md"}},{"name":"create_task_page","qualifiedName":"create_task_page","href":"views_after_auth_screens_tasks_create_task_page/views_after_auth_screens_tasks_create_task_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CreateTaskPage","qualifiedName":"create_task_page.CreateTaskPage","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CreateTaskPage returns a widget for page to create task for the user.","enclosedBy":{"name":"create_task_page","type":"library","href":"views_after_auth_screens_tasks_create_task_page/views_after_auth_screens_tasks_create_task_page-library.md"}},{"name":"CreateTaskPage","qualifiedName":"create_task_page.CreateTaskPage.CreateTaskPage","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskPage","type":"class","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md"}},{"name":"build","qualifiedName":"create_task_page.CreateTaskPage.build","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CreateTaskPage","type":"class","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md"}},{"name":"eventId","qualifiedName":"create_task_page.CreateTaskPage.eventId","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskPage","type":"class","href":"views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md"}},{"name":"create_task_view_model","qualifiedName":"create_task_view_model","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/view_model_after_auth_view_models_task_view_models_create_task_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CreateTaskViewModel","qualifiedName":"create_task_view_model.CreateTaskViewModel","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CreateTaskViewModel class helps to interact with model to serve data\nand react to user's input in Create Task view.","enclosedBy":{"name":"create_task_view_model","type":"library","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/view_model_after_auth_view_models_task_view_models_create_task_view_model-library.md"}},{"name":"CreateTaskViewModel","qualifiedName":"create_task_view_model.CreateTaskViewModel.CreateTaskViewModel","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/CreateTaskViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"createTask","qualifiedName":"create_task_view_model.CreateTaskViewModel.createTask","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function creates a new task for an event.\nThe function uses createTask method provided by Task Services.","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"dispose","qualifiedName":"create_task_view_model.CreateTaskViewModel.dispose","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Discards any resources used by the object. After this is called, the\nobject is not in a usable state and should be discarded (calls to\naddListener will throw after the object is disposed).","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"editTask","qualifiedName":"create_task_view_model.CreateTaskViewModel.editTask","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function updates the task.\nThe function uses editTask method provided by Task Services.","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"fillTask","qualifiedName":"create_task_view_model.CreateTaskViewModel.fillTask","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This functions fills the task controller data.","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"taskDescriptionTextController","qualifiedName":"create_task_view_model.CreateTaskViewModel.taskDescriptionTextController","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"taskEndDate","qualifiedName":"create_task_view_model.CreateTaskViewModel.taskEndDate","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"taskEndTime","qualifiedName":"create_task_view_model.CreateTaskViewModel.taskEndTime","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"taskTitleTextController","qualifiedName":"create_task_view_model.CreateTaskViewModel.taskTitleTextController","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CreateTaskViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md"}},{"name":"custom_alert_dialog","qualifiedName":"custom_alert_dialog","href":"widgets_custom_alert_dialog/widgets_custom_alert_dialog-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomAlertDialog","qualifiedName":"custom_alert_dialog.CustomAlertDialog","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This Class returns CustomAlertDialog widget. Custom Alert Dialog is a popup\nthat appeared in the screen showing Alert message along with the event buttons.\nThis extends stateless widget that means it cannot change its state during the\nruntime of a application.","enclosedBy":{"name":"custom_alert_dialog","type":"library","href":"widgets_custom_alert_dialog/widgets_custom_alert_dialog-library.md"}},{"name":"CustomAlertDialog","qualifiedName":"custom_alert_dialog.CustomAlertDialog.CustomAlertDialog","href":"widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"build","qualifiedName":"custom_alert_dialog.CustomAlertDialog.build","href":"widgets_custom_alert_dialog/CustomAlertDialog/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"dialogSubTitle","qualifiedName":"custom_alert_dialog.CustomAlertDialog.dialogSubTitle","href":"widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"dialogTitle","qualifiedName":"custom_alert_dialog.CustomAlertDialog.dialogTitle","href":"widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"reverse","qualifiedName":"custom_alert_dialog.CustomAlertDialog.reverse","href":"widgets_custom_alert_dialog/CustomAlertDialog/reverse.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"secondaryButtonTap","qualifiedName":"custom_alert_dialog.CustomAlertDialog.secondaryButtonTap","href":"widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"secondaryButtonText","qualifiedName":"custom_alert_dialog.CustomAlertDialog.secondaryButtonText","href":"widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"success","qualifiedName":"custom_alert_dialog.CustomAlertDialog.success","href":"widgets_custom_alert_dialog/CustomAlertDialog/success.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"successText","qualifiedName":"custom_alert_dialog.CustomAlertDialog.successText","href":"widgets_custom_alert_dialog/CustomAlertDialog/successText.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAlertDialog","type":"class","href":"widgets_custom_alert_dialog/CustomAlertDialog-class.md"}},{"name":"custom_avatar","qualifiedName":"custom_avatar","href":"widgets_custom_avatar/widgets_custom_avatar-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomAvatar","qualifiedName":"custom_avatar.CustomAvatar","href":"widgets_custom_avatar/CustomAvatar-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Creates a custom avatar.\nThe avatar is created using the image provided,\nor the first alphabet with a standard background color.","enclosedBy":{"name":"custom_avatar","type":"library","href":"widgets_custom_avatar/widgets_custom_avatar-library.md"}},{"name":"CustomAvatar","qualifiedName":"custom_avatar.CustomAvatar.CustomAvatar","href":"widgets_custom_avatar/CustomAvatar/CustomAvatar.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"build","qualifiedName":"custom_avatar.CustomAvatar.build","href":"widgets_custom_avatar/CustomAvatar/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"cacheManager","qualifiedName":"custom_avatar.CustomAvatar.cacheManager","href":"widgets_custom_avatar/CustomAvatar/cacheManager.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"firstAlphabet","qualifiedName":"custom_avatar.CustomAvatar.firstAlphabet","href":"widgets_custom_avatar/CustomAvatar/firstAlphabet.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"fontSize","qualifiedName":"custom_avatar.CustomAvatar.fontSize","href":"widgets_custom_avatar/CustomAvatar/fontSize.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"imageUrl","qualifiedName":"custom_avatar.CustomAvatar.imageUrl","href":"widgets_custom_avatar/CustomAvatar/imageUrl.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"isImageNull","qualifiedName":"custom_avatar.CustomAvatar.isImageNull","href":"widgets_custom_avatar/CustomAvatar/isImageNull.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomAvatar","type":"class","href":"widgets_custom_avatar/CustomAvatar-class.md"}},{"name":"custom_drawer","qualifiedName":"custom_drawer","href":"widgets_custom_drawer/widgets_custom_drawer-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomDrawer","qualifiedName":"custom_drawer.CustomDrawer","href":"widgets_custom_drawer/CustomDrawer-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Creates a custom drawer for switching organizations.","enclosedBy":{"name":"custom_drawer","type":"library","href":"widgets_custom_drawer/widgets_custom_drawer-library.md"}},{"name":"CustomDrawer","qualifiedName":"custom_drawer.CustomDrawer.CustomDrawer","href":"widgets_custom_drawer/CustomDrawer/CustomDrawer.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawer","type":"class","href":"widgets_custom_drawer/CustomDrawer-class.md"}},{"name":"build","qualifiedName":"custom_drawer.CustomDrawer.build","href":"widgets_custom_drawer/CustomDrawer/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomDrawer","type":"class","href":"widgets_custom_drawer/CustomDrawer-class.md"}},{"name":"exitButton","qualifiedName":"custom_drawer.CustomDrawer.exitButton","href":"widgets_custom_drawer/CustomDrawer/exitButton.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Button to exit the organization.","enclosedBy":{"name":"CustomDrawer","type":"class","href":"widgets_custom_drawer/CustomDrawer-class.md"}},{"name":"homeModel","qualifiedName":"custom_drawer.CustomDrawer.homeModel","href":"widgets_custom_drawer/CustomDrawer/homeModel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"home model.","enclosedBy":{"name":"CustomDrawer","type":"class","href":"widgets_custom_drawer/CustomDrawer-class.md"}},{"name":"custom_drawer_view_model","qualifiedName":"custom_drawer_view_model","href":"view_model_widgets_view_models_custom_drawer_view_model/view_model_widgets_view_models_custom_drawer_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomDrawerViewModel","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CustomDrawerViewModel class helps to serve the data and\nto react to user's input for Custom Dialog Widget.","enclosedBy":{"name":"custom_drawer_view_model","type":"library","href":"view_model_widgets_view_models_custom_drawer_view_model/view_model_widgets_view_models_custom_drawer_view_model-library.md"}},{"name":"CustomDrawerViewModel","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.CustomDrawerViewModel","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/CustomDrawerViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"controller","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.controller","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"dispose","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.dispose","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Discards any resources used by the object. After this is called, the\nobject is not in a usable state and should be discarded (calls to\naddListener will throw after the object is disposed).","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"initialize","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.initialize","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"isPresentinSwitchableOrg","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.isPresentinSwitchableOrg","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function checks switchOrg is present in the switchAbleOrg.","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"notifyListeners","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.notifyListeners","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Call all the registered listeners.","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"selectedOrg","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.selectedOrg","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/selectedOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"setSelectedOrganizationName","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.setSelectedOrganizationName","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/setSelectedOrganizationName.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function switches the current organization to new organization.","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"switchAbleOrg","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.switchAbleOrg","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchAbleOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"switchOrg","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.switchOrg","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function switch the current organization to another organization,\nif the organization(want switch to) is present.","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"targets","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.targets","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/targets.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"tutorialCoachMark","qualifiedName":"custom_drawer_view_model.CustomDrawerViewModel.tutorialCoachMark","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomDrawerViewModel","type":"class","href":"view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md"}},{"name":"custom_list_tile","qualifiedName":"custom_list_tile","href":"widgets_custom_list_tile/widgets_custom_list_tile-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomListTile","qualifiedName":"custom_list_tile.CustomListTile","href":"widgets_custom_list_tile/CustomListTile-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Returns a widget for rendering Customized tiles.\nA Tile shows the org info, user info, options that on tap user & org info.","enclosedBy":{"name":"custom_list_tile","type":"library","href":"widgets_custom_list_tile/widgets_custom_list_tile-library.md"}},{"name":"CustomListTile","qualifiedName":"custom_list_tile.CustomListTile.CustomListTile","href":"widgets_custom_list_tile/CustomListTile/CustomListTile.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"build","qualifiedName":"custom_list_tile.CustomListTile.build","href":"widgets_custom_list_tile/CustomListTile/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"index","qualifiedName":"custom_list_tile.CustomListTile.index","href":"widgets_custom_list_tile/CustomListTile/index.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"onTapOption","qualifiedName":"custom_list_tile.CustomListTile.onTapOption","href":"widgets_custom_list_tile/CustomListTile/onTapOption.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"onTapOrgInfo","qualifiedName":"custom_list_tile.CustomListTile.onTapOrgInfo","href":"widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"onTapUserInfo","qualifiedName":"custom_list_tile.CustomListTile.onTapUserInfo","href":"widgets_custom_list_tile/CustomListTile/onTapUserInfo.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"option","qualifiedName":"custom_list_tile.CustomListTile.option","href":"widgets_custom_list_tile/CustomListTile/option.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"orgInfo","qualifiedName":"custom_list_tile.CustomListTile.orgInfo","href":"widgets_custom_list_tile/CustomListTile/orgInfo.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"showIcon","qualifiedName":"custom_list_tile.CustomListTile.showIcon","href":"widgets_custom_list_tile/CustomListTile/showIcon.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"type","qualifiedName":"custom_list_tile.CustomListTile.type","href":"widgets_custom_list_tile/CustomListTile/type.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"userInfo","qualifiedName":"custom_list_tile.CustomListTile.userInfo","href":"widgets_custom_list_tile/CustomListTile/userInfo.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomListTile","type":"class","href":"widgets_custom_list_tile/CustomListTile-class.md"}},{"name":"custom_progress_dialog","qualifiedName":"custom_progress_dialog","href":"widgets_custom_progress_dialog/widgets_custom_progress_dialog-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomProgressDialog","qualifiedName":"custom_progress_dialog.CustomProgressDialog","href":"widgets_custom_progress_dialog/CustomProgressDialog-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"A progress dialogue which shows an activity indicator\nspinning clockwise if there is internet connectivity.\nOtherwise, it shows no-internet image and text.","enclosedBy":{"name":"custom_progress_dialog","type":"library","href":"widgets_custom_progress_dialog/widgets_custom_progress_dialog-library.md"}},{"name":"CustomProgressDialog","qualifiedName":"custom_progress_dialog.CustomProgressDialog.CustomProgressDialog","href":"widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomProgressDialog","type":"class","href":"widgets_custom_progress_dialog/CustomProgressDialog-class.md"}},{"name":"build","qualifiedName":"custom_progress_dialog.CustomProgressDialog.build","href":"widgets_custom_progress_dialog/CustomProgressDialog/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomProgressDialog","type":"class","href":"widgets_custom_progress_dialog/CustomProgressDialog-class.md"}},{"name":"custom_theme","qualifiedName":"custom_theme","href":"constants_custom_theme/constants_custom_theme-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TalawaTheme","qualifiedName":"custom_theme.TalawaTheme","href":"constants_custom_theme/TalawaTheme-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This file contains various custom themes.\nFor instance, lightTheme, darkTheme, _lightTextTheme, _darkTextTheme, etc.\nThese are imported to other files/widgets to apply the required themes.","enclosedBy":{"name":"custom_theme","type":"library","href":"constants_custom_theme/constants_custom_theme-library.md"}},{"name":"TalawaTheme","qualifiedName":"custom_theme.TalawaTheme.TalawaTheme","href":"constants_custom_theme/TalawaTheme/TalawaTheme.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaTheme","type":"class","href":"constants_custom_theme/TalawaTheme-class.md"}},{"name":"darkTheme","qualifiedName":"custom_theme.TalawaTheme.darkTheme","href":"constants_custom_theme/TalawaTheme/darkTheme.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaTheme","type":"class","href":"constants_custom_theme/TalawaTheme-class.md"}},{"name":"lightTheme","qualifiedName":"custom_theme.TalawaTheme.lightTheme","href":"constants_custom_theme/TalawaTheme/lightTheme.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaTheme","type":"class","href":"constants_custom_theme/TalawaTheme-class.md"}},{"name":"database_mutation_functions","qualifiedName":"database_mutation_functions","href":"services_database_mutation_functions/services_database_mutation_functions-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DataBaseMutationFunctions","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"DataBaseMutationFunctions class provides different services that are under the context of graphQL mutations and queries.","enclosedBy":{"name":"database_mutation_functions","type":"library","href":"services_database_mutation_functions/services_database_mutation_functions-library.md"}},{"name":"DataBaseMutationFunctions","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.DataBaseMutationFunctions","href":"services_database_mutation_functions/DataBaseMutationFunctions/DataBaseMutationFunctions.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"clientAuth","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.clientAuth","href":"services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Client Auth for handling authenticated request.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"clientNonAuth","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.clientNonAuth","href":"services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Client Auth for handling non-authenticated request.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"emailAccountPresent","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.emailAccountPresent","href":"services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"encounteredExceptionOrError","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.encounteredExceptionOrError","href":"services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to check if any exceptions or error encountered. The return type is boolean.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"fetchOrgById","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.fetchOrgById","href":"services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch the organization using the id passed.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"gqlAuthMutation","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.gqlAuthMutation","href":"services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to run the graph-ql mutation for authenticated user.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"gqlAuthQuery","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.gqlAuthQuery","href":"services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to run the graph-ql query for authentication.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"gqlNonAuthMutation","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.gqlNonAuthMutation","href":"services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to run the graph-ql mutation to authenticate the non signed-in user.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"gqlNonAuthQuery","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.gqlNonAuthQuery","href":"services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to run the graph-ql query for the non signed-in user.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"init","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.init","href":"services_database_mutation_functions/DataBaseMutationFunctions/init.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"initialization function.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"memberRequestExist","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.memberRequestExist","href":"services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"notifFeatureNotInstalled","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.notifFeatureNotInstalled","href":"services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"organizationNotFound","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.organizationNotFound","href":"services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"refreshAccessToken","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.refreshAccessToken","href":"services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to refresh the Authenication token to access the application.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"refreshAccessTokenExpiredException","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.refreshAccessTokenExpiredException","href":"services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"userNotAuthenticated","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.userNotAuthenticated","href":"services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"userNotFound","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.userNotFound","href":"services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"wrongCredentials","qualifiedName":"database_mutation_functions.DataBaseMutationFunctions.wrongCredentials","href":"services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Graphql error for handling.","enclosedBy":{"name":"DataBaseMutationFunctions","type":"class","href":"services_database_mutation_functions/DataBaseMutationFunctions-class.md"}},{"name":"date_time_picker","qualifiedName":"date_time_picker","href":"widgets_date_time_picker/widgets_date_time_picker-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"customDatePicker","qualifiedName":"date_time_picker.customDatePicker","href":"widgets_date_time_picker/customDatePicker.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"Shows a dialog containing a Material Design date picker.","enclosedBy":{"name":"date_time_picker","type":"library","href":"widgets_date_time_picker/widgets_date_time_picker-library.md"}},{"name":"customTimePicker","qualifiedName":"date_time_picker.customTimePicker","href":"widgets_date_time_picker/customTimePicker.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"Shows a dialog containing a material design time picker.","enclosedBy":{"name":"date_time_picker","type":"library","href":"widgets_date_time_picker/widgets_date_time_picker-library.md"}},{"name":"direct_chat_demo_data","qualifiedName":"direct_chat_demo_data","href":"demo_server_data_direct_chat_demo_data/demo_server_data_direct_chat_demo_data-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"directChatDemoData","qualifiedName":"direct_chat_demo_data.directChatDemoData","href":"demo_server_data_direct_chat_demo_data/directChatDemoData-constant.md","type":"top-level constant","overriddenDepth":0,"packageName":"talawa","desc":"This file contains demo data.","enclosedBy":{"name":"direct_chat_demo_data","type":"library","href":"demo_server_data_direct_chat_demo_data/demo_server_data_direct_chat_demo_data-library.md"}},{"name":"direct_chat_view_model","qualifiedName":"direct_chat_view_model","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DirectChatViewModel","qualifiedName":"direct_chat_view_model.DirectChatViewModel","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This ViewModel class have different functions that are used interact with model in the context of Direct Chat.","enclosedBy":{"name":"direct_chat_view_model","type":"library","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model-library.md"}},{"name":"DirectChatViewModel","qualifiedName":"direct_chat_view_model.DirectChatViewModel.DirectChatViewModel","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/DirectChatViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"chatMessagesByUser","qualifiedName":"direct_chat_view_model.DirectChatViewModel.chatMessagesByUser","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"chatName","qualifiedName":"direct_chat_view_model.DirectChatViewModel.chatName","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"chatState","qualifiedName":"direct_chat_view_model.DirectChatViewModel.chatState","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"chats","qualifiedName":"direct_chat_view_model.DirectChatViewModel.chats","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"dispose","qualifiedName":"direct_chat_view_model.DirectChatViewModel.dispose","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Discards any resources used by the object. After this is called, the\nobject is not in a usable state and should be discarded (calls to\naddListener will throw after the object is disposed).","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"getChatMessages","qualifiedName":"direct_chat_view_model.DirectChatViewModel.getChatMessages","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function get all messages for a chat.","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"initialise","qualifiedName":"direct_chat_view_model.DirectChatViewModel.initialise","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"listKey","qualifiedName":"direct_chat_view_model.DirectChatViewModel.listKey","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"name","qualifiedName":"direct_chat_view_model.DirectChatViewModel.name","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"refreshChats","qualifiedName":"direct_chat_view_model.DirectChatViewModel.refreshChats","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function refresh the chats.","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"sendMessageToDirectChat","qualifiedName":"direct_chat_view_model.DirectChatViewModel.sendMessageToDirectChat","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function send the message to Direct Chat.","enclosedBy":{"name":"DirectChatViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md"}},{"name":"direct_chats","qualifiedName":"direct_chats","href":"views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChatTile","qualifiedName":"direct_chats.ChatTile","href":"views_after_auth_screens_chat_direct_chats/ChatTile-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ChatTile return a widget for a tile in the list of Direct Chats in the Chat List Screen.","enclosedBy":{"name":"direct_chats","type":"library","href":"views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md"}},{"name":"ChatTile","qualifiedName":"direct_chats.ChatTile.ChatTile","href":"views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatTile","type":"class","href":"views_after_auth_screens_chat_direct_chats/ChatTile-class.md"}},{"name":"build","qualifiedName":"direct_chats.ChatTile.build","href":"views_after_auth_screens_chat_direct_chats/ChatTile/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"ChatTile","type":"class","href":"views_after_auth_screens_chat_direct_chats/ChatTile-class.md"}},{"name":"chat","qualifiedName":"direct_chats.ChatTile.chat","href":"views_after_auth_screens_chat_direct_chats/ChatTile/chat.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatTile","type":"class","href":"views_after_auth_screens_chat_direct_chats/ChatTile-class.md"}},{"name":"model","qualifiedName":"direct_chats.ChatTile.model","href":"views_after_auth_screens_chat_direct_chats/ChatTile/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatTile","type":"class","href":"views_after_auth_screens_chat_direct_chats/ChatTile-class.md"}},{"name":"DirectChats","qualifiedName":"direct_chats.DirectChats","href":"views_after_auth_screens_chat_direct_chats/DirectChats-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"DirectChats return a statelessWidget for rendering all the directs\nchats of the current user in the Chat List Screen","enclosedBy":{"name":"direct_chats","type":"library","href":"views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md"}},{"name":"DirectChats","qualifiedName":"direct_chats.DirectChats.DirectChats","href":"views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DirectChats","type":"class","href":"views_after_auth_screens_chat_direct_chats/DirectChats-class.md"}},{"name":"build","qualifiedName":"direct_chats.DirectChats.build","href":"views_after_auth_screens_chat_direct_chats/DirectChats/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"DirectChats","type":"class","href":"views_after_auth_screens_chat_direct_chats/DirectChats-class.md"}},{"name":"edit_event_page","qualifiedName":"edit_event_page","href":"views_after_auth_screens_events_edit_event_page/views_after_auth_screens_events_edit_event_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EditEventPage","qualifiedName":"edit_event_page.EditEventPage","href":"views_after_auth_screens_events_edit_event_page/EditEventPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EditEventPage returns a widget that has mutable state _EditEventPageState.","enclosedBy":{"name":"edit_event_page","type":"library","href":"views_after_auth_screens_events_edit_event_page/views_after_auth_screens_events_edit_event_page-library.md"}},{"name":"EditEventPage","qualifiedName":"edit_event_page.EditEventPage.EditEventPage","href":"views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventPage","type":"class","href":"views_after_auth_screens_events_edit_event_page/EditEventPage-class.md"}},{"name":"createState","qualifiedName":"edit_event_page.EditEventPage.createState","href":"views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"EditEventPage","type":"class","href":"views_after_auth_screens_events_edit_event_page/EditEventPage-class.md"}},{"name":"event","qualifiedName":"edit_event_page.EditEventPage.event","href":"views_after_auth_screens_events_edit_event_page/EditEventPage/event.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventPage","type":"class","href":"views_after_auth_screens_events_edit_event_page/EditEventPage-class.md"}},{"name":"edit_event_view_model","qualifiedName":"edit_event_view_model","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/view_model_after_auth_view_models_event_view_models_edit_event_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EditEventViewModel","qualifiedName":"edit_event_view_model.EditEventViewModel","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EditEventViewModel class have methods to interact with model in\nthe context of editing the event in the organization.","enclosedBy":{"name":"edit_event_view_model","type":"library","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/view_model_after_auth_view_models_event_view_models_edit_event_view_model-library.md"}},{"name":"EditEventViewModel","qualifiedName":"edit_event_view_model.EditEventViewModel.EditEventViewModel","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/EditEventViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"descriptionFocus","qualifiedName":"edit_event_view_model.EditEventViewModel.descriptionFocus","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventDescriptionTextController","qualifiedName":"edit_event_view_model.EditEventViewModel.eventDescriptionTextController","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventEndDate","qualifiedName":"edit_event_view_model.EditEventViewModel.eventEndDate","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventEndTime","qualifiedName":"edit_event_view_model.EditEventViewModel.eventEndTime","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventLocationTextController","qualifiedName":"edit_event_view_model.EditEventViewModel.eventLocationTextController","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventStartDate","qualifiedName":"edit_event_view_model.EditEventViewModel.eventStartDate","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventStartTime","qualifiedName":"edit_event_view_model.EditEventViewModel.eventStartTime","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"eventTitleTextController","qualifiedName":"edit_event_view_model.EditEventViewModel.eventTitleTextController","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"formKey","qualifiedName":"edit_event_view_model.EditEventViewModel.formKey","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"initialize","qualifiedName":"edit_event_view_model.EditEventViewModel.initialize","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"isPublicSwitch","qualifiedName":"edit_event_view_model.EditEventViewModel.isPublicSwitch","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"isRegisterableSwitch","qualifiedName":"edit_event_view_model.EditEventViewModel.isRegisterableSwitch","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"locationFocus","qualifiedName":"edit_event_view_model.EditEventViewModel.locationFocus","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"titleFocus","qualifiedName":"edit_event_view_model.EditEventViewModel.titleFocus","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"updateEvent","qualifiedName":"edit_event_view_model.EditEventViewModel.updateEvent","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to update an event.\nThe function uses editEvent function provided by eventService service.","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"validate","qualifiedName":"edit_event_view_model.EditEventViewModel.validate","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md"}},{"name":"edit_events_form","qualifiedName":"edit_events_form","href":"views_after_auth_screens_events_edit_events_form/views_after_auth_screens_events_edit_events_form-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EditEventForm","qualifiedName":"edit_events_form.EditEventForm","href":"views_after_auth_screens_events_edit_events_form/EditEventForm-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EditEventForm returns a widget of a Form for editing an event.\nThis widget is used in EditEventPage widget.","enclosedBy":{"name":"edit_events_form","type":"library","href":"views_after_auth_screens_events_edit_events_form/views_after_auth_screens_events_edit_events_form-library.md"}},{"name":"EditEventForm","qualifiedName":"edit_events_form.EditEventForm.EditEventForm","href":"views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventForm","type":"class","href":"views_after_auth_screens_events_edit_events_form/EditEventForm-class.md"}},{"name":"build","qualifiedName":"edit_events_form.EditEventForm.build","href":"views_after_auth_screens_events_edit_events_form/EditEventForm/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"EditEventForm","type":"class","href":"views_after_auth_screens_events_edit_events_form/EditEventForm-class.md"}},{"name":"model","qualifiedName":"edit_events_form.EditEventForm.model","href":"views_after_auth_screens_events_edit_events_form/EditEventForm/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditEventForm","type":"class","href":"views_after_auth_screens_events_edit_events_form/EditEventForm-class.md"}},{"name":"edit_profile_page","qualifiedName":"edit_profile_page","href":"views_after_auth_screens_profile_edit_profile_page/views_after_auth_screens_profile_edit_profile_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EditProfilePage","qualifiedName":"edit_profile_page.EditProfilePage","href":"views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EditProfilePage returns a widget that has mutable state _EditProfilePageState.","enclosedBy":{"name":"edit_profile_page","type":"library","href":"views_after_auth_screens_profile_edit_profile_page/views_after_auth_screens_profile_edit_profile_page-library.md"}},{"name":"EditProfilePage","qualifiedName":"edit_profile_page.EditProfilePage.EditProfilePage","href":"views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePage","type":"class","href":"views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md"}},{"name":"createState","qualifiedName":"edit_profile_page.EditProfilePage.createState","href":"views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"EditProfilePage","type":"class","href":"views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md"}},{"name":"edit_profile_view_model","qualifiedName":"edit_profile_view_model","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EditProfilePageViewModel","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EditProfilePageViewModel class helps to interact with model to serve data to edit profile views.","enclosedBy":{"name":"edit_profile_view_model","type":"library","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model-library.md"}},{"name":"EditProfilePageViewModel","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.EditProfilePageViewModel","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/EditProfilePageViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"databaseService","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.databaseService","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"firstNameFocus","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.firstNameFocus","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"firstNameTextController","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.firstNameTextController","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"getImageFromGallery","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.getImageFromGallery","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get the image from gallery.\nThe function uses the _multiMediaPickerService services.","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"imageFile","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.imageFile","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"initialize","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.initialize","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"lastNameFocus","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.lastNameFocus","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"lastNameTextController","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.lastNameTextController","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"removeImage","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.removeImage","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function remove the selected image.","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"user","qualifiedName":"edit_profile_view_model.EditProfilePageViewModel.user","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md"}},{"name":"edit_task_page","qualifiedName":"edit_task_page","href":"views_after_auth_screens_tasks_edit_task_page/views_after_auth_screens_tasks_edit_task_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EditTaskPage","qualifiedName":"edit_task_page.EditTaskPage","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EditTaskPage returns a widget for page to edit the task for the user.","enclosedBy":{"name":"edit_task_page","type":"library","href":"views_after_auth_screens_tasks_edit_task_page/views_after_auth_screens_tasks_edit_task_page-library.md"}},{"name":"EditTaskPage","qualifiedName":"edit_task_page.EditTaskPage.EditTaskPage","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditTaskPage","type":"class","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md"}},{"name":"build","qualifiedName":"edit_task_page.EditTaskPage.build","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"EditTaskPage","type":"class","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md"}},{"name":"task","qualifiedName":"edit_task_page.EditTaskPage.task","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EditTaskPage","type":"class","href":"views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md"}},{"name":"enums","qualifiedName":"enums","href":"enums_enums/enums_enums-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CallFor","qualifiedName":"enums.CallFor","href":"enums_enums/CallFor.md","type":"enum","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"enums","type":"library","href":"enums_enums/enums_enums-library.md"}},{"name":"CallFor","qualifiedName":"enums.CallFor.CallFor","href":"enums_enums/CallFor/CallFor.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CallFor","type":"enum","href":"enums_enums/CallFor.md"}},{"name":"values","qualifiedName":"enums.CallFor.values","href":"enums_enums/CallFor/values-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"CallFor","type":"enum","href":"enums_enums/CallFor.md"}},{"name":"ChatState","qualifiedName":"enums.ChatState","href":"enums_enums/ChatState.md","type":"enum","overriddenDepth":0,"packageName":"talawa","desc":"Represents the state of the chat","enclosedBy":{"name":"enums","type":"library","href":"enums_enums/enums_enums-library.md"}},{"name":"ChatState","qualifiedName":"enums.ChatState.ChatState","href":"enums_enums/ChatState/ChatState.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChatState","type":"enum","href":"enums_enums/ChatState.md"}},{"name":"values","qualifiedName":"enums.ChatState.values","href":"enums_enums/ChatState/values-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"ChatState","type":"enum","href":"enums_enums/ChatState.md"}},{"name":"MessageType","qualifiedName":"enums.MessageType","href":"enums_enums/MessageType.md","type":"enum","overriddenDepth":0,"packageName":"talawa","desc":"Represents the type of the Message","enclosedBy":{"name":"enums","type":"library","href":"enums_enums/enums_enums-library.md"}},{"name":"MessageType","qualifiedName":"enums.MessageType.MessageType","href":"enums_enums/MessageType/MessageType.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MessageType","type":"enum","href":"enums_enums/MessageType.md"}},{"name":"values","qualifiedName":"enums.MessageType.values","href":"enums_enums/MessageType/values-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"MessageType","type":"enum","href":"enums_enums/MessageType.md"}},{"name":"ModalSheet","qualifiedName":"enums.ModalSheet","href":"enums_enums/ModalSheet.md","type":"enum","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"enums","type":"library","href":"enums_enums/enums_enums-library.md"}},{"name":"ModalSheet","qualifiedName":"enums.ModalSheet.ModalSheet","href":"enums_enums/ModalSheet/ModalSheet.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ModalSheet","type":"enum","href":"enums_enums/ModalSheet.md"}},{"name":"values","qualifiedName":"enums.ModalSheet.values","href":"enums_enums/ModalSheet/values-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"ModalSheet","type":"enum","href":"enums_enums/ModalSheet.md"}},{"name":"TileType","qualifiedName":"enums.TileType","href":"enums_enums/TileType.md","type":"enum","overriddenDepth":0,"packageName":"talawa","desc":"Represents the type of the tile","enclosedBy":{"name":"enums","type":"library","href":"enums_enums/enums_enums-library.md"}},{"name":"TileType","qualifiedName":"enums.TileType.TileType","href":"enums_enums/TileType/TileType.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TileType","type":"enum","href":"enums_enums/TileType.md"}},{"name":"values","qualifiedName":"enums.TileType.values","href":"enums_enums/TileType/values-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"TileType","type":"enum","href":"enums_enums/TileType.md"}},{"name":"ViewState","qualifiedName":"enums.ViewState","href":"enums_enums/ViewState.md","type":"enum","overriddenDepth":0,"packageName":"talawa","desc":"This file contains different enums.\nThe enum keyword is used to define an enumeration type in Dart.\nThe use case of enumeration is to store finite data members under the same type definition.\nRepresents the state of the view","enclosedBy":{"name":"enums","type":"library","href":"enums_enums/enums_enums-library.md"}},{"name":"ViewState","qualifiedName":"enums.ViewState.ViewState","href":"enums_enums/ViewState/ViewState.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ViewState","type":"enum","href":"enums_enums/ViewState.md"}},{"name":"values","qualifiedName":"enums.ViewState.values","href":"enums_enums/ViewState/values-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"ViewState","type":"enum","href":"enums_enums/ViewState.md"}},{"name":"event_calendar","qualifiedName":"event_calendar","href":"views_after_auth_screens_events_event_calendar/views_after_auth_screens_events_event_calendar-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventCalendar","qualifiedName":"event_calendar.EventCalendar","href":"views_after_auth_screens_events_event_calendar/EventCalendar-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventCalendar returns a widget that has mutable state _EventCalendarState.","enclosedBy":{"name":"event_calendar","type":"library","href":"views_after_auth_screens_events_event_calendar/views_after_auth_screens_events_event_calendar-library.md"}},{"name":"EventCalendar","qualifiedName":"event_calendar.EventCalendar.EventCalendar","href":"views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCalendar","type":"class","href":"views_after_auth_screens_events_event_calendar/EventCalendar-class.md"}},{"name":"createState","qualifiedName":"event_calendar.EventCalendar.createState","href":"views_after_auth_screens_events_event_calendar/EventCalendar/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"EventCalendar","type":"class","href":"views_after_auth_screens_events_event_calendar/EventCalendar-class.md"}},{"name":"eventList","qualifiedName":"event_calendar.EventCalendar.eventList","href":"views_after_auth_screens_events_event_calendar/EventCalendar/eventList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCalendar","type":"class","href":"views_after_auth_screens_events_event_calendar/EventCalendar-class.md"}},{"name":"event_card","qualifiedName":"event_card","href":"widgets_event_card/widgets_event_card-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventCard","qualifiedName":"event_card.EventCard","href":"widgets_event_card/EventCard-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns the EventCard widget.","enclosedBy":{"name":"event_card","type":"library","href":"widgets_event_card/widgets_event_card-library.md"}},{"name":"EventCard","qualifiedName":"event_card.EventCard.EventCard","href":"widgets_event_card/EventCard/EventCard.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCard","type":"class","href":"widgets_event_card/EventCard-class.md"}},{"name":"build","qualifiedName":"event_card.EventCard.build","href":"widgets_event_card/EventCard/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"EventCard","type":"class","href":"widgets_event_card/EventCard-class.md"}},{"name":"event","qualifiedName":"event_card.EventCard.event","href":"widgets_event_card/EventCard/event.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCard","type":"class","href":"widgets_event_card/EventCard-class.md"}},{"name":"eventTitleHighlightedText","qualifiedName":"event_card.EventCard.eventTitleHighlightedText","href":"widgets_event_card/EventCard/eventTitleHighlightedText.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCard","type":"class","href":"widgets_event_card/EventCard-class.md"}},{"name":"eventTitleNormalText","qualifiedName":"event_card.EventCard.eventTitleNormalText","href":"widgets_event_card/EventCard/eventTitleNormalText.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCard","type":"class","href":"widgets_event_card/EventCard-class.md"}},{"name":"isSearchItem","qualifiedName":"event_card.EventCard.isSearchItem","href":"widgets_event_card/EventCard/isSearchItem.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventCard","type":"class","href":"widgets_event_card/EventCard-class.md"}},{"name":"event_card_view_model","qualifiedName":"event_card_view_model","href":"view_model_widgets_view_models_event_card_view_model/view_model_widgets_view_models_event_card_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"event_chats","qualifiedName":"event_chats","href":"views_after_auth_screens_chat_event_chats/views_after_auth_screens_chat_event_chats-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventChats","qualifiedName":"event_chats.EventChats","href":"views_after_auth_screens_chat_event_chats/EventChats-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventChats return a statelessWidget for rendering all the events\nchats of the current user in the Chat List Screen","enclosedBy":{"name":"event_chats","type":"library","href":"views_after_auth_screens_chat_event_chats/views_after_auth_screens_chat_event_chats-library.md"}},{"name":"EventChats","qualifiedName":"event_chats.EventChats.EventChats","href":"views_after_auth_screens_chat_event_chats/EventChats/EventChats.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventChats","type":"class","href":"views_after_auth_screens_chat_event_chats/EventChats-class.md"}},{"name":"build","qualifiedName":"event_chats.EventChats.build","href":"views_after_auth_screens_chat_event_chats/EventChats/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"EventChats","type":"class","href":"views_after_auth_screens_chat_event_chats/EventChats-class.md"}},{"name":"event_date_time_tile","qualifiedName":"event_date_time_tile","href":"widgets_event_date_time_tile/widgets_event_date_time_tile-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DateTimeTile","qualifiedName":"event_date_time_tile.DateTimeTile","href":"widgets_event_date_time_tile/DateTimeTile-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Returns a widget tile(item) for displaying date and time.","enclosedBy":{"name":"event_date_time_tile","type":"library","href":"widgets_event_date_time_tile/widgets_event_date_time_tile-library.md"}},{"name":"DateTimeTile","qualifiedName":"event_date_time_tile.DateTimeTile.DateTimeTile","href":"widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DateTimeTile","type":"class","href":"widgets_event_date_time_tile/DateTimeTile-class.md"}},{"name":"build","qualifiedName":"event_date_time_tile.DateTimeTile.build","href":"widgets_event_date_time_tile/DateTimeTile/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"DateTimeTile","type":"class","href":"widgets_event_date_time_tile/DateTimeTile-class.md"}},{"name":"date","qualifiedName":"event_date_time_tile.DateTimeTile.date","href":"widgets_event_date_time_tile/DateTimeTile/date.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DateTimeTile","type":"class","href":"widgets_event_date_time_tile/DateTimeTile-class.md"}},{"name":"setDate","qualifiedName":"event_date_time_tile.DateTimeTile.setDate","href":"widgets_event_date_time_tile/DateTimeTile/setDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DateTimeTile","type":"class","href":"widgets_event_date_time_tile/DateTimeTile-class.md"}},{"name":"setTime","qualifiedName":"event_date_time_tile.DateTimeTile.setTime","href":"widgets_event_date_time_tile/DateTimeTile/setTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DateTimeTile","type":"class","href":"widgets_event_date_time_tile/DateTimeTile-class.md"}},{"name":"time","qualifiedName":"event_date_time_tile.DateTimeTile.time","href":"widgets_event_date_time_tile/DateTimeTile/time.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DateTimeTile","type":"class","href":"widgets_event_date_time_tile/DateTimeTile-class.md"}},{"name":"event_info_body","qualifiedName":"event_info_body","href":"views_after_auth_screens_events_event_info_body/views_after_auth_screens_events_event_info_body-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventInfoBody","qualifiedName":"event_info_body.EventInfoBody","href":"views_after_auth_screens_events_event_info_body/EventInfoBody-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventInfoBody returns a stateless widget which describes the body of a particular event.","enclosedBy":{"name":"event_info_body","type":"library","href":"views_after_auth_screens_events_event_info_body/views_after_auth_screens_events_event_info_body-library.md"}},{"name":"EventInfoBody","qualifiedName":"event_info_body.EventInfoBody.EventInfoBody","href":"views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoBody","type":"class","href":"views_after_auth_screens_events_event_info_body/EventInfoBody-class.md"}},{"name":"build","qualifiedName":"event_info_body.EventInfoBody.build","href":"views_after_auth_screens_events_event_info_body/EventInfoBody/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"EventInfoBody","type":"class","href":"views_after_auth_screens_events_event_info_body/EventInfoBody-class.md"}},{"name":"event_info_page","qualifiedName":"event_info_page","href":"views_after_auth_screens_events_event_info_page/views_after_auth_screens_events_event_info_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventInfoPage","qualifiedName":"event_info_page.EventInfoPage","href":"views_after_auth_screens_events_event_info_page/EventInfoPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventInfoPage returns a widget that has mutable state _EventInfoPageState.","enclosedBy":{"name":"event_info_page","type":"library","href":"views_after_auth_screens_events_event_info_page/views_after_auth_screens_events_event_info_page-library.md"}},{"name":"EventInfoPage","qualifiedName":"event_info_page.EventInfoPage.EventInfoPage","href":"views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoPage","type":"class","href":"views_after_auth_screens_events_event_info_page/EventInfoPage-class.md"}},{"name":"args","qualifiedName":"event_info_page.EventInfoPage.args","href":"views_after_auth_screens_events_event_info_page/EventInfoPage/args.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoPage","type":"class","href":"views_after_auth_screens_events_event_info_page/EventInfoPage-class.md"}},{"name":"createState","qualifiedName":"event_info_page.EventInfoPage.createState","href":"views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"EventInfoPage","type":"class","href":"views_after_auth_screens_events_event_info_page/EventInfoPage-class.md"}},{"name":"event_info_view_model","qualifiedName":"event_info_view_model","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/view_model_after_auth_view_models_event_view_models_event_info_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventInfoViewModel","qualifiedName":"event_info_view_model.EventInfoViewModel","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventInfoViewModel class helps interacting with model to serve view with the event information data.'","enclosedBy":{"name":"event_info_view_model","type":"library","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/view_model_after_auth_view_models_event_view_models_event_info_view_model-library.md"}},{"name":"EventInfoViewModel","qualifiedName":"event_info_view_model.EventInfoViewModel.EventInfoViewModel","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/EventInfoViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"event","qualifiedName":"event_info_view_model.EventInfoViewModel.event","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"exploreEventsInstance","qualifiedName":"event_info_view_model.EventInfoViewModel.exploreEventsInstance","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"fabTitle","qualifiedName":"event_info_view_model.EventInfoViewModel.fabTitle","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"getFabTitle","qualifiedName":"event_info_view_model.EventInfoViewModel.getFabTitle","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function returns String type for the event registration status.","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"initialize","qualifiedName":"event_info_view_model.EventInfoViewModel.initialize","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"initialise with the event data fetched from the model.","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"registerForEvent","qualifiedName":"event_info_view_model.EventInfoViewModel.registerForEvent","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function helps the user to register for an event.","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"registrants","qualifiedName":"event_info_view_model.EventInfoViewModel.registrants","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventInfoViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md"}},{"name":"event_model","qualifiedName":"event_model","href":"models_events_event_model/models_events_event_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Event","qualifiedName":"event_model.Event","href":"models_events_event_model/Event-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates an event model and returns an Event instance.","enclosedBy":{"name":"event_model","type":"library","href":"models_events_event_model/models_events_event_model-library.md"}},{"name":"Event","qualifiedName":"event_model.Event.Event","href":"models_events_event_model/Event/Event.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"admins","qualifiedName":"event_model.Event.admins","href":"models_events_event_model/Event/admins.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"allDay","qualifiedName":"event_model.Event.allDay","href":"models_events_event_model/Event/allDay.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"attendees","qualifiedName":"event_model.Event.attendees","href":"models_events_event_model/Event/attendees.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"creator","qualifiedName":"event_model.Event.creator","href":"models_events_event_model/Event/creator.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"description","qualifiedName":"event_model.Event.description","href":"models_events_event_model/Event/description.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"endDate","qualifiedName":"event_model.Event.endDate","href":"models_events_event_model/Event/endDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"endTime","qualifiedName":"event_model.Event.endTime","href":"models_events_event_model/Event/endTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"Event.fromJson","qualifiedName":"event_model.Event.fromJson","href":"models_events_event_model/Event/Event.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"id","qualifiedName":"event_model.Event.id","href":"models_events_event_model/Event/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"isPublic","qualifiedName":"event_model.Event.isPublic","href":"models_events_event_model/Event/isPublic.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"isRegisterable","qualifiedName":"event_model.Event.isRegisterable","href":"models_events_event_model/Event/isRegisterable.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"isRegistered","qualifiedName":"event_model.Event.isRegistered","href":"models_events_event_model/Event/isRegistered.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"latitude","qualifiedName":"event_model.Event.latitude","href":"models_events_event_model/Event/latitude.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"location","qualifiedName":"event_model.Event.location","href":"models_events_event_model/Event/location.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"longitude","qualifiedName":"event_model.Event.longitude","href":"models_events_event_model/Event/longitude.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"organization","qualifiedName":"event_model.Event.organization","href":"models_events_event_model/Event/organization.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"recurrence","qualifiedName":"event_model.Event.recurrence","href":"models_events_event_model/Event/recurrence.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"recurring","qualifiedName":"event_model.Event.recurring","href":"models_events_event_model/Event/recurring.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"registrants","qualifiedName":"event_model.Event.registrants","href":"models_events_event_model/Event/registrants.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"startDate","qualifiedName":"event_model.Event.startDate","href":"models_events_event_model/Event/startDate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"startTime","qualifiedName":"event_model.Event.startTime","href":"models_events_event_model/Event/startTime.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"title","qualifiedName":"event_model.Event.title","href":"models_events_event_model/Event/title.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Event","type":"class","href":"models_events_event_model/Event-class.md"}},{"name":"event_queries","qualifiedName":"event_queries","href":"utils_event_queries/utils_event_queries-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventQueries","qualifiedName":"event_queries.EventQueries","href":"utils_event_queries/EventQueries-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates queries related to the events.","enclosedBy":{"name":"event_queries","type":"library","href":"utils_event_queries/utils_event_queries-library.md"}},{"name":"EventQueries","qualifiedName":"event_queries.EventQueries.EventQueries","href":"utils_event_queries/EventQueries/EventQueries.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"addEvent","qualifiedName":"event_queries.EventQueries.addEvent","href":"utils_event_queries/EventQueries/addEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"deleteEvent","qualifiedName":"event_queries.EventQueries.deleteEvent","href":"utils_event_queries/EventQueries/deleteEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"fetchOrgEvents","qualifiedName":"event_queries.EventQueries.fetchOrgEvents","href":"utils_event_queries/EventQueries/fetchOrgEvents.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"registerForEvent","qualifiedName":"event_queries.EventQueries.registerForEvent","href":"utils_event_queries/EventQueries/registerForEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"registrantsByEvent","qualifiedName":"event_queries.EventQueries.registrantsByEvent","href":"utils_event_queries/EventQueries/registrantsByEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"updateEvent","qualifiedName":"event_queries.EventQueries.updateEvent","href":"utils_event_queries/EventQueries/updateEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventQueries","type":"class","href":"utils_event_queries/EventQueries-class.md"}},{"name":"event_search_delegate","qualifiedName":"event_search_delegate","href":"widgets_event_search_delegate/widgets_event_search_delegate-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventSearch","qualifiedName":"event_search_delegate.EventSearch","href":"widgets_event_search_delegate/EventSearch-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns a list of the events which match the search query.","enclosedBy":{"name":"event_search_delegate","type":"library","href":"widgets_event_search_delegate/widgets_event_search_delegate-library.md"}},{"name":"EventSearch","qualifiedName":"event_search_delegate.EventSearch.EventSearch","href":"widgets_event_search_delegate/EventSearch/EventSearch.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"buildActions","qualifiedName":"event_search_delegate.EventSearch.buildActions","href":"widgets_event_search_delegate/EventSearch/buildActions.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Widgets to display after the search query in the AppBar.","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"buildLeading","qualifiedName":"event_search_delegate.EventSearch.buildLeading","href":"widgets_event_search_delegate/EventSearch/buildLeading.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"A widget to display before the current query in the AppBar.","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"buildResults","qualifiedName":"event_search_delegate.EventSearch.buildResults","href":"widgets_event_search_delegate/EventSearch/buildResults.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"The results shown after the user submits a search from the search page.","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"buildSuggestions","qualifiedName":"event_search_delegate.EventSearch.buildSuggestions","href":"widgets_event_search_delegate/EventSearch/buildSuggestions.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Suggestions shown in the body of the search page while the user types a\nquery into the search field.","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"buildSuggestionsSucess","qualifiedName":"event_search_delegate.EventSearch.buildSuggestionsSucess","href":"widgets_event_search_delegate/EventSearch/buildSuggestionsSucess.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"eventList","qualifiedName":"event_search_delegate.EventSearch.eventList","href":"widgets_event_search_delegate/EventSearch/eventList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"exploreEventsViewModel","qualifiedName":"event_search_delegate.EventSearch.exploreEventsViewModel","href":"widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventSearch","type":"class","href":"widgets_event_search_delegate/EventSearch-class.md"}},{"name":"event_service","qualifiedName":"event_service","href":"services_event_service/services_event_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventService","qualifiedName":"event_service.EventService","href":"services_event_service/EventService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventService class provides different services in the context of Event.","enclosedBy":{"name":"event_service","type":"library","href":"services_event_service/services_event_service-library.md"}},{"name":"EventService","qualifiedName":"event_service.EventService.EventService","href":"services_event_service/EventService/EventService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"deleteEvent","qualifiedName":"event_service.EventService.deleteEvent","href":"services_event_service/EventService/deleteEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to delete the event.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"dispose","qualifiedName":"event_service.EventService.dispose","href":"services_event_service/EventService/dispose.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to cancel the stream subscription of an organization.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"editEvent","qualifiedName":"event_service.EventService.editEvent","href":"services_event_service/EventService/editEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to edit an event.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"eventStream","qualifiedName":"event_service.EventService.eventStream","href":"services_event_service/EventService/eventStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"The event stream.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"fetchRegistrantsByEvent","qualifiedName":"event_service.EventService.fetchRegistrantsByEvent","href":"services_event_service/EventService/fetchRegistrantsByEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to fetch all registrants of an event.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"getEvents","qualifiedName":"event_service.EventService.getEvents","href":"services_event_service/EventService/getEvents.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to fetch all the events of an organization.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"registerForAnEvent","qualifiedName":"event_service.EventService.registerForAnEvent","href":"services_event_service/EventService/registerForAnEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to register user for an event.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"setOrgStreamSubscription","qualifiedName":"event_service.EventService.setOrgStreamSubscription","href":"services_event_service/EventService/setOrgStreamSubscription.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to set stream subscription for an organization.","enclosedBy":{"name":"EventService","type":"class","href":"services_event_service/EventService-class.md"}},{"name":"event_tasks_page","qualifiedName":"event_tasks_page","href":"views_after_auth_screens_tasks_event_tasks_page/views_after_auth_screens_tasks_event_tasks_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"EventTasksPage","qualifiedName":"event_tasks_page.EventTasksPage","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"EventTasksPage return a widget for Event Task Page that is created by event creator.","enclosedBy":{"name":"event_tasks_page","type":"library","href":"views_after_auth_screens_tasks_event_tasks_page/views_after_auth_screens_tasks_event_tasks_page-library.md"}},{"name":"EventTasksPage","qualifiedName":"event_tasks_page.EventTasksPage.EventTasksPage","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventTasksPage","type":"class","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md"}},{"name":"build","qualifiedName":"event_tasks_page.EventTasksPage.build","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"EventTasksPage","type":"class","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md"}},{"name":"eventId","qualifiedName":"event_tasks_page.EventTasksPage.eventId","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"EventTasksPage","type":"class","href":"views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md"}},{"name":"events_demo_data","qualifiedName":"events_demo_data","href":"demo_server_data_events_demo_data/demo_server_data_events_demo_data-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"eventsDemoData","qualifiedName":"events_demo_data.eventsDemoData","href":"demo_server_data_events_demo_data/eventsDemoData-constant.md","type":"top-level constant","overriddenDepth":0,"packageName":"talawa","desc":"This file contains demo data. It contains a list of type Map<String, Object>\nand sample data of events.","enclosedBy":{"name":"events_demo_data","type":"library","href":"demo_server_data_events_demo_data/demo_server_data_events_demo_data-library.md"}},{"name":"explore_event_dialogue","qualifiedName":"explore_event_dialogue","href":"views_after_auth_screens_events_explore_event_dialogue/views_after_auth_screens_events_explore_event_dialogue-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ExploreEventDialog","qualifiedName":"explore_event_dialogue.ExploreEventDialog","href":"views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ExploreEventDialog returns a widget that has mutable state _ExploreEventDialogState.","enclosedBy":{"name":"explore_event_dialogue","type":"library","href":"views_after_auth_screens_events_explore_event_dialogue/views_after_auth_screens_events_explore_event_dialogue-library.md"}},{"name":"ExploreEventDialog","qualifiedName":"explore_event_dialogue.ExploreEventDialog.ExploreEventDialog","href":"views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventDialog","type":"class","href":"views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md"}},{"name":"createState","qualifiedName":"explore_event_dialogue.ExploreEventDialog.createState","href":"views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"ExploreEventDialog","type":"class","href":"views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md"}},{"name":"explore_events","qualifiedName":"explore_events","href":"views_after_auth_screens_events_explore_events/views_after_auth_screens_events_explore_events-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ExploreEvents","qualifiedName":"explore_events.ExploreEvents","href":"views_after_auth_screens_events_explore_events/ExploreEvents-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Shows the list of events with options to categorize them.","enclosedBy":{"name":"explore_events","type":"library","href":"views_after_auth_screens_events_explore_events/views_after_auth_screens_events_explore_events-library.md"}},{"name":"ExploreEvents","qualifiedName":"explore_events.ExploreEvents.ExploreEvents","href":"views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEvents","type":"class","href":"views_after_auth_screens_events_explore_events/ExploreEvents-class.md"}},{"name":"build","qualifiedName":"explore_events.ExploreEvents.build","href":"views_after_auth_screens_events_explore_events/ExploreEvents/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"ExploreEvents","type":"class","href":"views_after_auth_screens_events_explore_events/ExploreEvents-class.md"}},{"name":"dropDownList","qualifiedName":"explore_events.ExploreEvents.dropDownList","href":"views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Shows a list of dropdown taken from model and context.","enclosedBy":{"name":"ExploreEvents","type":"class","href":"views_after_auth_screens_events_explore_events/ExploreEvents-class.md"}},{"name":"homeModel","qualifiedName":"explore_events.ExploreEvents.homeModel","href":"views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"homeModal is a type of MainScreenViewModel which provides methods to handle the data for this component.","enclosedBy":{"name":"ExploreEvents","type":"class","href":"views_after_auth_screens_events_explore_events/ExploreEvents-class.md"}},{"name":"explore_events_view_model","qualifiedName":"explore_events_view_model","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/view_model_after_auth_view_models_event_view_models_explore_events_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ExploreEventsViewModel","qualifiedName":"explore_events_view_model.ExploreEventsViewModel","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ExploreEventsViewModel class helps to interact with model to serve data to view for event explore section.","enclosedBy":{"name":"explore_events_view_model","type":"library","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/view_model_after_auth_view_models_event_view_models_explore_events_view_model-library.md"}},{"name":"ExploreEventsViewModel","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.ExploreEventsViewModel","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/ExploreEventsViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"checkIfExistsAndAddNewEvent","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.checkIfExistsAndAddNewEvent","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function add a new event if the event not exist.","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"choseValueFromDropdown","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.choseValueFromDropdown","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function takes the choosen value from dropdown and\nreturn the filter events, if empty list then return relevant message.","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"chosenValue","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.chosenValue","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"deleteEvent","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.deleteEvent","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function deletes the event.","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"dispose","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.dispose","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Discards any resources used by the object. After this is called, the\nobject is not in a usable state and should be discarded (calls to\naddListener will throw after the object is disposed).","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"emptyListMessage","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.emptyListMessage","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"eventService","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.eventService","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"events","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.events","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"fetchNewEvents","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.fetchNewEvents","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to fetch new events in the organization.\nThe function uses getEvents method from EventService.","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"initialise","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.initialise","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"refreshEvents","qualifiedName":"explore_events_view_model.ExploreEventsViewModel.refreshEvents","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to refresh the events in the organization.\nThe function uses getEvents method from EventService.","enclosedBy":{"name":"ExploreEventsViewModel","type":"class","href":"view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md"}},{"name":"explore_tasks_view_model","qualifiedName":"explore_tasks_view_model","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ExploreTasksViewModel","qualifiedName":"explore_tasks_view_model.ExploreTasksViewModel","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ExploreTasksViewModel class helps to interact with model to serve data\nand react to user's input in Explore Task section.","enclosedBy":{"name":"explore_tasks_view_model","type":"library","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model-library.md"}},{"name":"ExploreTasksViewModel","qualifiedName":"explore_tasks_view_model.ExploreTasksViewModel.ExploreTasksViewModel","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreTasksViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md"}},{"name":"deleteTask","qualifiedName":"explore_tasks_view_model.ExploreTasksViewModel.deleteTask","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function deletes the task for an event.\nThe function uses deleteTask method of Task Service.","enclosedBy":{"name":"ExploreTasksViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md"}},{"name":"fetchTasks","qualifiedName":"explore_tasks_view_model.ExploreTasksViewModel.fetchTasks","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch all the task for an event.\nThe function uses getTasksForEvent method of Task Service.","enclosedBy":{"name":"ExploreTasksViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md"}},{"name":"fetchTasksByUser","qualifiedName":"explore_tasks_view_model.ExploreTasksViewModel.fetchTasksByUser","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch tasks created by the current user for an event.\nThe function uses getTasksByUser method of Task Service.","enclosedBy":{"name":"ExploreTasksViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md"}},{"name":"tasks","qualifiedName":"explore_tasks_view_model.ExploreTasksViewModel.tasks","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ExploreTasksViewModel","type":"class","href":"view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md"}},{"name":"fetch_plugin_list","qualifiedName":"fetch_plugin_list","href":"plugins_fetch_plugin_list/plugins_fetch_plugin_list-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"FetchPluginList","qualifiedName":"fetch_plugin_list.FetchPluginList","href":"plugins_fetch_plugin_list/FetchPluginList-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class fetch plugins list.","enclosedBy":{"name":"fetch_plugin_list","type":"library","href":"plugins_fetch_plugin_list/plugins_fetch_plugin_list-library.md"}},{"name":"FetchPluginList","qualifiedName":"fetch_plugin_list.FetchPluginList.FetchPluginList","href":"plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"Constructor of the class.","enclosedBy":{"name":"FetchPluginList","type":"class","href":"plugins_fetch_plugin_list/FetchPluginList-class.md"}},{"name":"box","qualifiedName":"fetch_plugin_list.FetchPluginList.box","href":"plugins_fetch_plugin_list/FetchPluginList/box.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"late initialize the box.","enclosedBy":{"name":"FetchPluginList","type":"class","href":"plugins_fetch_plugin_list/FetchPluginList-class.md"}},{"name":"fetchList","qualifiedName":"fetch_plugin_list.FetchPluginList.fetchList","href":"plugins_fetch_plugin_list/FetchPluginList/fetchList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Fetches plugins from server and stores them in Hive pluginBox.","enclosedBy":{"name":"FetchPluginList","type":"class","href":"plugins_fetch_plugin_list/FetchPluginList-class.md"}},{"name":"firebase_options","qualifiedName":"firebase_options","href":"firebase_options/firebase_options-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DefaultFirebaseOptions","qualifiedName":"firebase_options.DefaultFirebaseOptions","href":"firebase_options/DefaultFirebaseOptions-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Default FirebaseOptions for use with your Firebase apps.","enclosedBy":{"name":"firebase_options","type":"library","href":"firebase_options/firebase_options-library.md"}},{"name":"DefaultFirebaseOptions","qualifiedName":"firebase_options.DefaultFirebaseOptions.DefaultFirebaseOptions","href":"firebase_options/DefaultFirebaseOptions/DefaultFirebaseOptions.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DefaultFirebaseOptions","type":"class","href":"firebase_options/DefaultFirebaseOptions-class.md"}},{"name":"android","qualifiedName":"firebase_options.DefaultFirebaseOptions.android","href":"firebase_options/DefaultFirebaseOptions/android.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Scaffolds androidFirebaseOptions around FirebaseOptions.","enclosedBy":{"name":"DefaultFirebaseOptions","type":"class","href":"firebase_options/DefaultFirebaseOptions-class.md"}},{"name":"currentPlatform","qualifiedName":"firebase_options.DefaultFirebaseOptions.currentPlatform","href":"firebase_options/DefaultFirebaseOptions/currentPlatform.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Builds and returns FirebaseOptions based on the current platform.","enclosedBy":{"name":"DefaultFirebaseOptions","type":"class","href":"firebase_options/DefaultFirebaseOptions-class.md"}},{"name":"ios","qualifiedName":"firebase_options.DefaultFirebaseOptions.ios","href":"firebase_options/DefaultFirebaseOptions/ios.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Scaffolds iosFirebaseOptions around FirebaseOptions.","enclosedBy":{"name":"DefaultFirebaseOptions","type":"class","href":"firebase_options/DefaultFirebaseOptions-class.md"}},{"name":"from_palisadoes","qualifiedName":"from_palisadoes","href":"widgets_from_palisadoes/widgets_from_palisadoes-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"FromPalisadoes","qualifiedName":"from_palisadoes.FromPalisadoes","href":"widgets_from_palisadoes/FromPalisadoes-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class generates the text \"From Palisadoes\" in a custom way.","enclosedBy":{"name":"from_palisadoes","type":"library","href":"widgets_from_palisadoes/widgets_from_palisadoes-library.md"}},{"name":"FromPalisadoes","qualifiedName":"from_palisadoes.FromPalisadoes.FromPalisadoes","href":"widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"FromPalisadoes","type":"class","href":"widgets_from_palisadoes/FromPalisadoes-class.md"}},{"name":"build","qualifiedName":"from_palisadoes.FromPalisadoes.build","href":"widgets_from_palisadoes/FromPalisadoes/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"FromPalisadoes","type":"class","href":"widgets_from_palisadoes/FromPalisadoes-class.md"}},{"name":"generated_plugin_registrant","qualifiedName":"generated_plugin_registrant","href":"generated_plugin_registrant/generated_plugin_registrant-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"registerPlugins","qualifiedName":"generated_plugin_registrant.registerPlugins","href":"generated_plugin_registrant/registerPlugins.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"generated_plugin_registrant","type":"library","href":"generated_plugin_registrant/generated_plugin_registrant-library.md"}},{"name":"graphql_config","qualifiedName":"graphql_config","href":"services_graphql_config/services_graphql_config-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"GraphqlConfig","qualifiedName":"graphql_config.GraphqlConfig","href":"services_graphql_config/GraphqlConfig-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data.\nTalawa uses graphQL for the integrating with the API's.\nYou can go through talawa-api, here.\nGraphqlConfig class provides service to configure graph ql API with talawa mobile-app.","enclosedBy":{"name":"graphql_config","type":"library","href":"services_graphql_config/services_graphql_config-library.md"}},{"name":"GraphqlConfig","qualifiedName":"graphql_config.GraphqlConfig.GraphqlConfig","href":"services_graphql_config/GraphqlConfig/GraphqlConfig.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"authClient","qualifiedName":"graphql_config.GraphqlConfig.authClient","href":"services_graphql_config/GraphqlConfig/authClient.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"clientToQuery","qualifiedName":"graphql_config.GraphqlConfig.clientToQuery","href":"services_graphql_config/GraphqlConfig/clientToQuery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"displayImgRoute","qualifiedName":"graphql_config.GraphqlConfig.displayImgRoute","href":"services_graphql_config/GraphqlConfig/displayImgRoute.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"getOrgUrl","qualifiedName":"graphql_config.GraphqlConfig.getOrgUrl","href":"services_graphql_config/GraphqlConfig/getOrgUrl.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get the organization URL.","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"getToken","qualifiedName":"graphql_config.GraphqlConfig.getToken","href":"services_graphql_config/GraphqlConfig/getToken.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get user the access token.","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"httpLink","qualifiedName":"graphql_config.GraphqlConfig.httpLink","href":"services_graphql_config/GraphqlConfig/httpLink.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"imageUrlKey","qualifiedName":"graphql_config.GraphqlConfig.imageUrlKey","href":"services_graphql_config/GraphqlConfig/imageUrlKey-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"orgURI","qualifiedName":"graphql_config.GraphqlConfig.orgURI","href":"services_graphql_config/GraphqlConfig/orgURI.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"test","qualifiedName":"graphql_config.GraphqlConfig.test","href":"services_graphql_config/GraphqlConfig/test.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"token","qualifiedName":"graphql_config.GraphqlConfig.token","href":"services_graphql_config/GraphqlConfig/token.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"urlKey","qualifiedName":"graphql_config.GraphqlConfig.urlKey","href":"services_graphql_config/GraphqlConfig/urlKey-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"webSocketLink","qualifiedName":"graphql_config.GraphqlConfig.webSocketLink","href":"services_graphql_config/GraphqlConfig/webSocketLink.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"GraphqlConfig","type":"class","href":"services_graphql_config/GraphqlConfig-class.md"}},{"name":"MockHttpClient","qualifiedName":"graphql_config.MockHttpClient","href":"services_graphql_config/MockHttpClient-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"A mock HTTP client designed for use when testing code that uses BaseClient.","enclosedBy":{"name":"graphql_config","type":"library","href":"services_graphql_config/services_graphql_config-library.md"}},{"name":"MockHttpClient","qualifiedName":"graphql_config.MockHttpClient.MockHttpClient","href":"services_graphql_config/MockHttpClient/MockHttpClient.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MockHttpClient","type":"class","href":"services_graphql_config/MockHttpClient-class.md"}},{"name":"send","qualifiedName":"graphql_config.MockHttpClient.send","href":"services_graphql_config/MockHttpClient/send.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Sends an HTTP request and asynchronously returns the response.","enclosedBy":{"name":"MockHttpClient","type":"class","href":"services_graphql_config/MockHttpClient-class.md"}},{"name":"individual_post","qualifiedName":"individual_post","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CommentTemplate","qualifiedName":"individual_post.CommentTemplate","href":"views_after_auth_screens_feed_individual_post/CommentTemplate-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CommentTemplate returns a widget of the individual user commented on the post.","enclosedBy":{"name":"individual_post","type":"library","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md"}},{"name":"CommentTemplate","qualifiedName":"individual_post.CommentTemplate.CommentTemplate","href":"views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentTemplate","type":"class","href":"views_after_auth_screens_feed_individual_post/CommentTemplate-class.md"}},{"name":"build","qualifiedName":"individual_post.CommentTemplate.build","href":"views_after_auth_screens_feed_individual_post/CommentTemplate/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CommentTemplate","type":"class","href":"views_after_auth_screens_feed_individual_post/CommentTemplate-class.md"}},{"name":"comment","qualifiedName":"individual_post.CommentTemplate.comment","href":"views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CommentTemplate","type":"class","href":"views_after_auth_screens_feed_individual_post/CommentTemplate-class.md"}},{"name":"IndividualPageLikeSection","qualifiedName":"individual_post.IndividualPageLikeSection","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"IndividualPageLikeSection returns a widget that show the list of all the users liked the post.","enclosedBy":{"name":"individual_post","type":"library","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md"}},{"name":"IndividualPageLikeSection","qualifiedName":"individual_post.IndividualPageLikeSection.IndividualPageLikeSection","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPageLikeSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md"}},{"name":"build","qualifiedName":"individual_post.IndividualPageLikeSection.build","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"IndividualPageLikeSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md"}},{"name":"usersLiked","qualifiedName":"individual_post.IndividualPageLikeSection.usersLiked","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPageLikeSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md"}},{"name":"IndividualPostCommentSection","qualifiedName":"individual_post.IndividualPostCommentSection","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"IndividualPostCommentSection returns a widget that show the list of all the users commented on the post.","enclosedBy":{"name":"individual_post","type":"library","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md"}},{"name":"IndividualPostCommentSection","qualifiedName":"individual_post.IndividualPostCommentSection.IndividualPostCommentSection","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPostCommentSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md"}},{"name":"build","qualifiedName":"individual_post.IndividualPostCommentSection.build","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"IndividualPostCommentSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md"}},{"name":"comments","qualifiedName":"individual_post.IndividualPostCommentSection.comments","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPostCommentSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md"}},{"name":"postID","qualifiedName":"individual_post.IndividualPostCommentSection.postID","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPostCommentSection","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md"}},{"name":"IndividualPostView","qualifiedName":"individual_post.IndividualPostView","href":"views_after_auth_screens_feed_individual_post/IndividualPostView-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"IndividualPostView returns a widget that has mutable state _IndividualPostViewState.","enclosedBy":{"name":"individual_post","type":"library","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md"}},{"name":"IndividualPostView","qualifiedName":"individual_post.IndividualPostView.IndividualPostView","href":"views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPostView","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostView-class.md"}},{"name":"createState","qualifiedName":"individual_post.IndividualPostView.createState","href":"views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"IndividualPostView","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostView-class.md"}},{"name":"post","qualifiedName":"individual_post.IndividualPostView.post","href":"views_after_auth_screens_feed_individual_post/IndividualPostView/post.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"IndividualPostView","type":"class","href":"views_after_auth_screens_feed_individual_post/IndividualPostView-class.md"}},{"name":"buildPadding","qualifiedName":"individual_post.buildPadding","href":"views_after_auth_screens_feed_individual_post/buildPadding.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"individual_post","type":"library","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md"}},{"name":"likedUserCircleAvatar","qualifiedName":"individual_post.likedUserCircleAvatar","href":"views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"likedUserCircleAvatar returns a widget of the individual user liked the post.","enclosedBy":{"name":"individual_post","type":"library","href":"views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md"}},{"name":"invite_child","qualifiedName":"invite_child","href":"widgets_invite_child/widgets_invite_child-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"iconButton","qualifiedName":"invite_child.iconButton","href":"widgets_invite_child/iconButton.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"This function is for debugging purposes.\nIt prints \"tapped\" in the console for the developer to know that the button was tapped.","enclosedBy":{"name":"invite_child","type":"library","href":"widgets_invite_child/widgets_invite_child-library.md"}},{"name":"invite","qualifiedName":"invite_child.invite","href":"widgets_invite_child/invite.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"This widget gives us various options to invite someone to an organization.\nWe can use QR code scanner, social media platforms like twitter, whatsapp, telegram and many more.","enclosedBy":{"name":"invite_child","type":"library","href":"widgets_invite_child/widgets_invite_child-library.md"}},{"name":"join_organisation_after_auth","qualifiedName":"join_organisation_after_auth","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"JoinOrganisationAfterAuth","qualifiedName":"join_organisation_after_auth.JoinOrganisationAfterAuth","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"JoinOrganisationAfterAuth returns a widget for page to join the organization just after user authentication.","enclosedBy":{"name":"join_organisation_after_auth","type":"library","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth-library.md"}},{"name":"JoinOrganisationAfterAuth","qualifiedName":"join_organisation_after_auth.JoinOrganisationAfterAuth.JoinOrganisationAfterAuth","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"JoinOrganisationAfterAuth","type":"class","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md"}},{"name":"build","qualifiedName":"join_organisation_after_auth.JoinOrganisationAfterAuth.build","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"JoinOrganisationAfterAuth","type":"class","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md"}},{"name":"orgId","qualifiedName":"join_organisation_after_auth.JoinOrganisationAfterAuth.orgId","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"JoinOrganisationAfterAuth","type":"class","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md"}},{"name":"scanQR","qualifiedName":"join_organisation_after_auth.JoinOrganisationAfterAuth.scanQR","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"scanQR returns a widget that is use in joining the organization via the QR code.","enclosedBy":{"name":"JoinOrganisationAfterAuth","type":"class","href":"views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md"}},{"name":"lang_switch","qualifiedName":"lang_switch","href":"widgets_lang_switch/widgets_lang_switch-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"LanguageTile","qualifiedName":"lang_switch.LanguageTile","href":"widgets_lang_switch/LanguageTile-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget enables language switch for \"internationalizing our app\".","enclosedBy":{"name":"lang_switch","type":"library","href":"widgets_lang_switch/widgets_lang_switch-library.md"}},{"name":"LanguageTile","qualifiedName":"lang_switch.LanguageTile.LanguageTile","href":"widgets_lang_switch/LanguageTile/LanguageTile.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LanguageTile","type":"class","href":"widgets_lang_switch/LanguageTile-class.md"}},{"name":"build","qualifiedName":"lang_switch.LanguageTile.build","href":"widgets_lang_switch/LanguageTile/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"LanguageTile","type":"class","href":"widgets_lang_switch/LanguageTile-class.md"}},{"name":"lang_view_model","qualifiedName":"lang_view_model","href":"view_model_lang_view_model/view_model_lang_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AppLanguage","qualifiedName":"lang_view_model.AppLanguage","href":"view_model_lang_view_model/AppLanguage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"AppLanguage view model class interact with modal in the context of the App Language.\nThe class provides methods that set's the language, change the language in the modal.","enclosedBy":{"name":"lang_view_model","type":"library","href":"view_model_lang_view_model/view_model_lang_view_model-library.md"}},{"name":"AppLanguage","qualifiedName":"lang_view_model.AppLanguage.AppLanguage","href":"view_model_lang_view_model/AppLanguage/AppLanguage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"appLanguageQuery","qualifiedName":"lang_view_model.AppLanguage.appLanguageQuery","href":"view_model_lang_view_model/AppLanguage/appLanguageQuery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function perform graphQL query to check the app language.\nThe function uses gqlAuthQuery method provided by Database Functions Services.","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"appLocal","qualifiedName":"lang_view_model.AppLanguage.appLocal","href":"view_model_lang_view_model/AppLanguage/appLocal.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"changeLanguage","qualifiedName":"lang_view_model.AppLanguage.changeLanguage","href":"view_model_lang_view_model/AppLanguage/changeLanguage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function change the app default language.","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"databaseFunctions","qualifiedName":"lang_view_model.AppLanguage.databaseFunctions","href":"view_model_lang_view_model/AppLanguage/databaseFunctions.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"dbLanguageUpdate","qualifiedName":"lang_view_model.AppLanguage.dbLanguageUpdate","href":"view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function updates the Database Language by running the graphQL mutations.","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"fetchLocale","qualifiedName":"lang_view_model.AppLanguage.fetchLocale","href":"view_model_lang_view_model/AppLanguage/fetchLocale.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch the language of the user's app.","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"initialize","qualifiedName":"lang_view_model.AppLanguage.initialize","href":"view_model_lang_view_model/AppLanguage/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"isTest","qualifiedName":"lang_view_model.AppLanguage.isTest","href":"view_model_lang_view_model/AppLanguage/isTest.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"navigationService","qualifiedName":"lang_view_model.AppLanguage.navigationService","href":"view_model_lang_view_model/AppLanguage/navigationService.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"selectLanguagePress","qualifiedName":"lang_view_model.AppLanguage.selectLanguagePress","href":"view_model_lang_view_model/AppLanguage/selectLanguagePress.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function navigate user to /appSettingsPage route if the user is authenticated\nelse navigate to /setUrl route.","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"userLanguageQuery","qualifiedName":"lang_view_model.AppLanguage.userLanguageQuery","href":"view_model_lang_view_model/AppLanguage/userLanguageQuery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function perform graphQL query to check the user's language in the database.\nThe function uses gqlAuthQuery method provided by Database Functions Services.","enclosedBy":{"name":"AppLanguage","type":"class","href":"view_model_lang_view_model/AppLanguage-class.md"}},{"name":"language_icon","qualifiedName":"language_icon","href":"custom_painters_language_icon/custom_painters_language_icon-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"LanguageIcon","qualifiedName":"language_icon.LanguageIcon","href":"custom_painters_language_icon/LanguageIcon-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class draws the language icon using custom paint.\nCustomPaint is a widget from the Flutter SDK, which enables\nyou to use a canvas to draw different shapes.","enclosedBy":{"name":"language_icon","type":"library","href":"custom_painters_language_icon/custom_painters_language_icon-library.md"}},{"name":"LanguageIcon","qualifiedName":"language_icon.LanguageIcon.LanguageIcon","href":"custom_painters_language_icon/LanguageIcon/LanguageIcon.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LanguageIcon","type":"class","href":"custom_painters_language_icon/LanguageIcon-class.md"}},{"name":"paint","qualifiedName":"language_icon.LanguageIcon.paint","href":"custom_painters_language_icon/LanguageIcon/paint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever the object needs to paint. The given Canvas has its\ncoordinate space configured such that the origin is at the top left of the\nbox. The area of the box is the size of the size argument.","enclosedBy":{"name":"LanguageIcon","type":"class","href":"custom_painters_language_icon/LanguageIcon-class.md"}},{"name":"shouldRepaint","qualifiedName":"language_icon.LanguageIcon.shouldRepaint","href":"custom_painters_language_icon/LanguageIcon/shouldRepaint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever a new instance of the custom painter delegate class is\nprovided to the RenderCustomPaint object, or any time that a new\nCustomPaint object is created with a new instance of the custom painter\ndelegate class (which amounts to the same thing, because the latter is\nimplemented in terms of the former).","enclosedBy":{"name":"LanguageIcon","type":"class","href":"custom_painters_language_icon/LanguageIcon-class.md"}},{"name":"language_model","qualifiedName":"language_model","href":"models_language_language_model/models_language_language_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Language","qualifiedName":"language_model.Language","href":"models_language_language_model/Language-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates an langauge model.","enclosedBy":{"name":"language_model","type":"library","href":"models_language_language_model/models_language_language_model-library.md"}},{"name":"Language","qualifiedName":"language_model.Language.Language","href":"models_language_language_model/Language/Language.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Language","type":"class","href":"models_language_language_model/Language-class.md"}},{"name":"countryCode","qualifiedName":"language_model.Language.countryCode","href":"models_language_language_model/Language/countryCode.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Language","type":"class","href":"models_language_language_model/Language-class.md"}},{"name":"langCode","qualifiedName":"language_model.Language.langCode","href":"models_language_language_model/Language/langCode.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Language","type":"class","href":"models_language_language_model/Language-class.md"}},{"name":"langName","qualifiedName":"language_model.Language.langName","href":"models_language_language_model/Language/langName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Language","type":"class","href":"models_language_language_model/Language-class.md"}},{"name":"langSample","qualifiedName":"language_model.Language.langSample","href":"models_language_language_model/Language/langSample.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Language","type":"class","href":"models_language_language_model/Language-class.md"}},{"name":"like_button_view_model","qualifiedName":"like_button_view_model","href":"view_model_widgets_view_models_like_button_view_model/view_model_widgets_view_models_like_button_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"LikeButtonViewModel","qualifiedName":"like_button_view_model.LikeButtonViewModel","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"LikeButtonViewModel class helps to serve the data and\nto react to user's input for Like Button Widget.","enclosedBy":{"name":"like_button_view_model","type":"library","href":"view_model_widgets_view_models_like_button_view_model/view_model_widgets_view_models_like_button_view_model-library.md"}},{"name":"LikeButtonViewModel","qualifiedName":"like_button_view_model.LikeButtonViewModel.LikeButtonViewModel","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/LikeButtonViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"checkAndSetTheIsLiked","qualifiedName":"like_button_view_model.LikeButtonViewModel.checkAndSetTheIsLiked","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"dispose","qualifiedName":"like_button_view_model.LikeButtonViewModel.dispose","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Discards any resources used by the object. After this is called, the\nobject is not in a usable state and should be discarded (calls to\naddListener will throw after the object is disposed).","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"initialize","qualifiedName":"like_button_view_model.LikeButtonViewModel.initialize","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"isLiked","qualifiedName":"like_button_view_model.LikeButtonViewModel.isLiked","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"likedBy","qualifiedName":"like_button_view_model.LikeButtonViewModel.likedBy","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"likesCount","qualifiedName":"like_button_view_model.LikeButtonViewModel.likesCount","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"setIsLiked","qualifiedName":"like_button_view_model.LikeButtonViewModel.setIsLiked","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function set _isLike to true.","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"toggleIsLiked","qualifiedName":"like_button_view_model.LikeButtonViewModel.toggleIsLiked","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function add like to the post if not liked and\nremove the like from the post if liked.","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"updatePost","qualifiedName":"like_button_view_model.LikeButtonViewModel.updatePost","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function updates the Post.","enclosedBy":{"name":"LikeButtonViewModel","type":"class","href":"view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md"}},{"name":"locator","qualifiedName":"locator","href":"locator/locator-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"connectivity","qualifiedName":"locator.connectivity","href":"locator/connectivity.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for Connectivity.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"databaseFunctions","qualifiedName":"locator.databaseFunctions","href":"locator/databaseFunctions.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for DataBaseMutationFunctions.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"graphqlConfig","qualifiedName":"locator.graphqlConfig","href":"locator/graphqlConfig.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for GraphqlConfig.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"imageCropper","qualifiedName":"locator.imageCropper","href":"locator/imageCropper.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for ImageCropper.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"imagePicker","qualifiedName":"locator.imagePicker","href":"locator/imagePicker.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for ImagePicker.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"locator","qualifiedName":"locator.locator","href":"locator/locator.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"Intializaing the locator.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"navigationService","qualifiedName":"locator.navigationService","href":"locator/navigationService.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for NavigationService.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"organizationService","qualifiedName":"locator.organizationService","href":"locator/organizationService.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for OrganizationService.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"queries","qualifiedName":"locator.queries","href":"locator/queries.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for Queries.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"setupLocator","qualifiedName":"locator.setupLocator","href":"locator/setupLocator.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"This function registers the widgets/objects in \"GetIt\".","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"sizeConfig","qualifiedName":"locator.sizeConfig","href":"locator/sizeConfig.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for SizeConfig.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"userConfig","qualifiedName":"locator.userConfig","href":"locator/userConfig.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"creating GetIt for UserConfig.","enclosedBy":{"name":"locator","type":"library","href":"locator/locator-library.md"}},{"name":"login","qualifiedName":"login","href":"views_pre_auth_screens_login/views_pre_auth_screens_login-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Login","qualifiedName":"login.Login","href":"views_pre_auth_screens_login/Login-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This is the login widget.\nThere are two input fiels. The first one takes in the email and\nthe second one takes in the password of the user.\nThere is also a \"Forgot Password\" text button, which directs to\nthe \"recover password\" screen when pressed.\nAt the bottom, there is a login button to initiate the login.","enclosedBy":{"name":"login","type":"library","href":"views_pre_auth_screens_login/views_pre_auth_screens_login-library.md"}},{"name":"Login","qualifiedName":"login.Login.Login","href":"views_pre_auth_screens_login/Login/Login.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Login","type":"class","href":"views_pre_auth_screens_login/Login-class.md"}},{"name":"createState","qualifiedName":"login.Login.createState","href":"views_pre_auth_screens_login/Login/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"Login","type":"class","href":"views_pre_auth_screens_login/Login-class.md"}},{"name":"login_view_model","qualifiedName":"login_view_model","href":"view_model_pre_auth_view_models_login_view_model/view_model_pre_auth_view_models_login_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"LoginViewModel","qualifiedName":"login_view_model.LoginViewModel","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"LoginViewModel class helps to interact with model to serve data\nand react to user's input in Login View.","enclosedBy":{"name":"login_view_model","type":"library","href":"view_model_pre_auth_view_models_login_view_model/view_model_pre_auth_view_models_login_view_model-library.md"}},{"name":"LoginViewModel","qualifiedName":"login_view_model.LoginViewModel.LoginViewModel","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/LoginViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"email","qualifiedName":"login_view_model.LoginViewModel.email","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"emailFocus","qualifiedName":"login_view_model.LoginViewModel.emailFocus","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"formKey","qualifiedName":"login_view_model.LoginViewModel.formKey","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"greeting","qualifiedName":"login_view_model.LoginViewModel.greeting","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"hidePassword","qualifiedName":"login_view_model.LoginViewModel.hidePassword","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"initialize","qualifiedName":"login_view_model.LoginViewModel.initialize","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"login","qualifiedName":"login_view_model.LoginViewModel.login","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to sign-in the user into application.","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"password","qualifiedName":"login_view_model.LoginViewModel.password","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"passwordFocus","qualifiedName":"login_view_model.LoginViewModel.passwordFocus","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"validate","qualifiedName":"login_view_model.LoginViewModel.validate","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LoginViewModel","type":"class","href":"view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md"}},{"name":"main","qualifiedName":"main","href":"main/main-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DemoPageView","qualifiedName":"main.DemoPageView","href":"main/DemoPageView-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"PageView is a scrollable list that works page by page.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"DemoPageView","qualifiedName":"main.DemoPageView.DemoPageView","href":"main/DemoPageView/DemoPageView.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DemoPageView","type":"class","href":"main/DemoPageView-class.md"}},{"name":"build","qualifiedName":"main.DemoPageView.build","href":"main/DemoPageView/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"DemoPageView","type":"class","href":"main/DemoPageView-class.md"}},{"name":"DemoViewModel","qualifiedName":"main.DemoViewModel","href":"main/DemoViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ViewModel uses property-based data binding to establish a connection.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"DemoViewModel","qualifiedName":"main.DemoViewModel.DemoViewModel","href":"main/DemoViewModel/DemoViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DemoViewModel","type":"class","href":"main/DemoViewModel-class.md"}},{"name":"title","qualifiedName":"main.DemoViewModel.title","href":"main/DemoViewModel/title.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Getter function of the title.","enclosedBy":{"name":"DemoViewModel","type":"class","href":"main/DemoViewModel-class.md"}},{"name":"MyApp","qualifiedName":"main.MyApp","href":"main/MyApp-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Main widget that sets up the quick actions, internationalization, routing , notifications.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"MyApp","qualifiedName":"main.MyApp.MyApp","href":"main/MyApp/MyApp.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MyApp","type":"class","href":"main/MyApp-class.md"}},{"name":"createState","qualifiedName":"main.MyApp.createState","href":"main/MyApp/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"MyApp","type":"class","href":"main/MyApp-class.md"}},{"name":"androidFirebaseOptions","qualifiedName":"main.androidFirebaseOptions","href":"main/androidFirebaseOptions.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"HashMap of Firebase options for android.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"channel","qualifiedName":"main.channel","href":"main/channel.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"Create a AndroidNotificationChannel for heads up notifications.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"flutterLocalNotificationsPlugin","qualifiedName":"main.flutterLocalNotificationsPlugin","href":"main/flutterLocalNotificationsPlugin.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"Initialize the FlutterLocalNotificationsPlugin package.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"iosFirebaseOptions","qualifiedName":"main.iosFirebaseOptions","href":"main/iosFirebaseOptions.md","type":"top-level property","overriddenDepth":0,"packageName":"talawa","desc":"HashMap of Firebase options for android.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"main","qualifiedName":"main.main","href":"main/main.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"First function to initialize the application, invoked automatically.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"setUpFirebase","qualifiedName":"main.setUpFirebase","href":"main/setUpFirebase.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"Initializes the firebase in the app according to the userplatform (android/iOS).","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"setUpFirebaseKeys","qualifiedName":"main.setUpFirebaseKeys","href":"main/setUpFirebaseKeys.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"Initializes the firebase keys in the app according to the userplatform (android/iOS).","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"setUpFirebaseMessaging","qualifiedName":"main.setUpFirebaseMessaging","href":"main/setUpFirebaseMessaging.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"Set up firebase instance, enbables messaging,listens to icoming messages.","enclosedBy":{"name":"main","type":"library","href":"main/main-library.md"}},{"name":"main_screen","qualifiedName":"main_screen","href":"views_main_screen/views_main_screen-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"MainScreen","qualifiedName":"main_screen.MainScreen","href":"views_main_screen/MainScreen-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"main_screen","type":"library","href":"views_main_screen/views_main_screen-library.md"}},{"name":"MainScreen","qualifiedName":"main_screen.MainScreen.MainScreen","href":"views_main_screen/MainScreen/MainScreen.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MainScreen","type":"class","href":"views_main_screen/MainScreen-class.md"}},{"name":"createState","qualifiedName":"main_screen.MainScreen.createState","href":"views_main_screen/MainScreen/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"MainScreen","type":"class","href":"views_main_screen/MainScreen-class.md"}},{"name":"mainScreenArgs","qualifiedName":"main_screen.MainScreen.mainScreenArgs","href":"views_main_screen/MainScreen/mainScreenArgs.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MainScreen","type":"class","href":"views_main_screen/MainScreen-class.md"}},{"name":"main_screen_view_model","qualifiedName":"main_screen_view_model","href":"view_model_main_screen_view_model/view_model_main_screen_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"MainScreenViewModel","qualifiedName":"main_screen_view_model.MainScreenViewModel","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"MainScreenViewModel class provide methods to interact with the modal to serve data in user's action in Main Screen Views.","enclosedBy":{"name":"main_screen_view_model","type":"library","href":"view_model_main_screen_view_model/view_model_main_screen_view_model-library.md"}},{"name":"MainScreenViewModel","qualifiedName":"main_screen_view_model.MainScreenViewModel.MainScreenViewModel","href":"view_model_main_screen_view_model/MainScreenViewModel/MainScreenViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"context","qualifiedName":"main_screen_view_model.MainScreenViewModel.context","href":"view_model_main_screen_view_model/MainScreenViewModel/context.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"context consist of parent info.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"currentPageIndex","qualifiedName":"main_screen_view_model.MainScreenViewModel.currentPageIndex","href":"view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"var for current page in index.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"fetchAndAddPlugins","qualifiedName":"main_screen_view_model.MainScreenViewModel.fetchAndAddPlugins","href":"view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Dynamically adds BottomNavigationBarItems in BottomNavigationBar.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"focusTarget","qualifiedName":"main_screen_view_model.MainScreenViewModel.focusTarget","href":"view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This returns a widget for a step in a tutorial.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"initialise","qualifiedName":"main_screen_view_model.MainScreenViewModel.initialise","href":"view_model_main_screen_view_model/MainScreenViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Initalizing function.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyBNChat","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyBNChat","href":"view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyBNEvents","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyBNEvents","href":"view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyBNHome","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyBNHome","href":"view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyBNPost","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyBNPost","href":"view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyBNProfile","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyBNProfile","href":"view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyDrawerCurOrg","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyDrawerCurOrg","href":"view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyDrawerJoinOrg","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyDrawerJoinOrg","href":"view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyDrawerLeaveCurrentOrg","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyDrawerLeaveCurrentOrg","href":"view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keyDrawerSwitchableOrg","qualifiedName":"main_screen_view_model.MainScreenViewModel.keyDrawerSwitchableOrg","href":"view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySEAdd","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySEAdd","href":"view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySECard","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySECard","href":"view_model_main_screen_view_model/MainScreenViewModel/keySECard.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySECategoryMenu","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySECategoryMenu","href":"view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySEDateFilter","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySEDateFilter","href":"view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySHMenuIcon","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySHMenuIcon","href":"view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySHOrgName","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySHOrgName","href":"view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySHPinnedPost","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySHPinnedPost","href":"view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySHPost","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySHPost","href":"view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPAppSetting","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPAppSetting","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPDonateUs","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPDonateUs","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPEditProfile","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPEditProfile","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPHelp","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPHelp","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPInvite","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPInvite","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPLogout","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPLogout","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"keySPPalisadoes","qualifiedName":"main_screen_view_model.MainScreenViewModel.keySPPalisadoes","href":"view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"navBarItems","qualifiedName":"main_screen_view_model.MainScreenViewModel.navBarItems","href":"view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Actual BottomNavigationBarItems that show up on the screen.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"onTabTapped","qualifiedName":"main_screen_view_model.MainScreenViewModel.onTabTapped","href":"view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Handles click on BottomNavigationBarItem.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"pages","qualifiedName":"main_screen_view_model.MainScreenViewModel.pages","href":"view_model_main_screen_view_model/MainScreenViewModel/pages.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Contains the Widgets to be rendered for corresponding navbar items.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"pluginList","qualifiedName":"main_screen_view_model.MainScreenViewModel.pluginList","href":"view_model_main_screen_view_model/MainScreenViewModel/pluginList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"list of all the pluginList.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"pluginPrototypeData","qualifiedName":"main_screen_view_model.MainScreenViewModel.pluginPrototypeData","href":"view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Maps the feature names with their proper Icon and Page.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"scaffoldKey","qualifiedName":"main_screen_view_model.MainScreenViewModel.scaffoldKey","href":"view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"showAppTour","qualifiedName":"main_screen_view_model.MainScreenViewModel.showAppTour","href":"view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"bool to determine if we wanna show the apptour.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"showHome","qualifiedName":"main_screen_view_model.MainScreenViewModel.showHome","href":"view_model_main_screen_view_model/MainScreenViewModel/showHome.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function shows the Home screen.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"showTutorial","qualifiedName":"main_screen_view_model.MainScreenViewModel.showTutorial","href":"view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function show tutorial to user.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"targets","qualifiedName":"main_screen_view_model.MainScreenViewModel.targets","href":"view_model_main_screen_view_model/MainScreenViewModel/targets.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"array of target.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourAddPost","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourAddPost","href":"view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function show the tutorial to add Post in the organization.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourChat","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourChat","href":"view_model_main_screen_view_model/MainScreenViewModel/tourChat.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function show the tour of chats.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourComplete","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourComplete","href":"view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"bool to determine if apptour is complete.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourEventTargets","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourEventTargets","href":"view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function show the tutorial for Events.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourHomeTargets","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourHomeTargets","href":"view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"this functions starts the tour and info to be displayed is mentioned in this functions.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourProfile","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourProfile","href":"view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function show the tutorial for the profile page.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tourSkipped","qualifiedName":"main_screen_view_model.MainScreenViewModel.tourSkipped","href":"view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"bool to determine if apptour is skipped.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"tutorialCoachMark","qualifiedName":"main_screen_view_model.MainScreenViewModel.tutorialCoachMark","href":"view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"tutorialCoachMark consist of coach used to give tutorial.","enclosedBy":{"name":"MainScreenViewModel","type":"class","href":"view_model_main_screen_view_model/MainScreenViewModel-class.md"}},{"name":"mainscreen_navigation_args","qualifiedName":"mainscreen_navigation_args","href":"models_mainscreen_navigation_args/models_mainscreen_navigation_args-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"MainScreenArgs","qualifiedName":"mainscreen_navigation_args.MainScreenArgs","href":"models_mainscreen_navigation_args/MainScreenArgs-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"mainscreen_navigation_args","type":"library","href":"models_mainscreen_navigation_args/models_mainscreen_navigation_args-library.md"}},{"name":"MainScreenArgs","qualifiedName":"mainscreen_navigation_args.MainScreenArgs.MainScreenArgs","href":"models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MainScreenArgs","type":"class","href":"models_mainscreen_navigation_args/MainScreenArgs-class.md"}},{"name":"fromSignUp","qualifiedName":"mainscreen_navigation_args.MainScreenArgs.fromSignUp","href":"models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MainScreenArgs","type":"class","href":"models_mainscreen_navigation_args/MainScreenArgs-class.md"}},{"name":"mainScreenIndex","qualifiedName":"mainscreen_navigation_args.MainScreenArgs.mainScreenIndex","href":"models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MainScreenArgs","type":"class","href":"models_mainscreen_navigation_args/MainScreenArgs-class.md"}},{"name":"map_screen","qualifiedName":"map_screen","href":"views_after_auth_screens_venue_map_screen/views_after_auth_screens_venue_map_screen-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"MapScreen","qualifiedName":"map_screen.MapScreen","href":"views_after_auth_screens_venue_map_screen/MapScreen-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"MapScreen returns a widget that has mutable state _MapScreenState.","enclosedBy":{"name":"map_screen","type":"library","href":"views_after_auth_screens_venue_map_screen/views_after_auth_screens_venue_map_screen-library.md"}},{"name":"MapScreen","qualifiedName":"map_screen.MapScreen.MapScreen","href":"views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MapScreen","type":"class","href":"views_after_auth_screens_venue_map_screen/MapScreen-class.md"}},{"name":"createState","qualifiedName":"map_screen.MapScreen.createState","href":"views_after_auth_screens_venue_map_screen/MapScreen/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"MapScreen","type":"class","href":"views_after_auth_screens_venue_map_screen/MapScreen-class.md"}},{"name":"latitude","qualifiedName":"map_screen.MapScreen.latitude","href":"views_after_auth_screens_venue_map_screen/MapScreen/latitude.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MapScreen","type":"class","href":"views_after_auth_screens_venue_map_screen/MapScreen-class.md"}},{"name":"longitude","qualifiedName":"map_screen.MapScreen.longitude","href":"views_after_auth_screens_venue_map_screen/MapScreen/longitude.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MapScreen","type":"class","href":"views_after_auth_screens_venue_map_screen/MapScreen-class.md"}},{"name":"model","qualifiedName":"map_screen.MapScreen.model","href":"views_after_auth_screens_venue_map_screen/MapScreen/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MapScreen","type":"class","href":"views_after_auth_screens_venue_map_screen/MapScreen-class.md"}},{"name":"member_name_tile","qualifiedName":"member_name_tile","href":"widgets_member_name_tile/widgets_member_name_tile-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"MemberNameTile","qualifiedName":"member_name_tile.MemberNameTile","href":"widgets_member_name_tile/MemberNameTile-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget returns a tile containing the name of the member.\nAlong with the name, there is a circle avatar which either contains\nthe image uploaded by the user or the first character of his/her name in\nuppercase.","enclosedBy":{"name":"member_name_tile","type":"library","href":"widgets_member_name_tile/widgets_member_name_tile-library.md"}},{"name":"MemberNameTile","qualifiedName":"member_name_tile.MemberNameTile.MemberNameTile","href":"widgets_member_name_tile/MemberNameTile/MemberNameTile.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MemberNameTile","type":"class","href":"widgets_member_name_tile/MemberNameTile-class.md"}},{"name":"build","qualifiedName":"member_name_tile.MemberNameTile.build","href":"widgets_member_name_tile/MemberNameTile/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"MemberNameTile","type":"class","href":"widgets_member_name_tile/MemberNameTile-class.md"}},{"name":"onDelete","qualifiedName":"member_name_tile.MemberNameTile.onDelete","href":"widgets_member_name_tile/MemberNameTile/onDelete.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MemberNameTile","type":"class","href":"widgets_member_name_tile/MemberNameTile-class.md"}},{"name":"userImage","qualifiedName":"member_name_tile.MemberNameTile.userImage","href":"widgets_member_name_tile/MemberNameTile/userImage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MemberNameTile","type":"class","href":"widgets_member_name_tile/MemberNameTile-class.md"}},{"name":"userName","qualifiedName":"member_name_tile.MemberNameTile.userName","href":"widgets_member_name_tile/MemberNameTile/userName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MemberNameTile","type":"class","href":"widgets_member_name_tile/MemberNameTile-class.md"}},{"name":"multi_media_pick_service","qualifiedName":"multi_media_pick_service","href":"services_third_party_service_multi_media_pick_service/services_third_party_service_multi_media_pick_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"MultiMediaPickerService","qualifiedName":"multi_media_pick_service.MultiMediaPickerService","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This is a third party service which provide the service to select the image from.","enclosedBy":{"name":"multi_media_pick_service","type":"library","href":"services_third_party_service_multi_media_pick_service/services_third_party_service_multi_media_pick_service-library.md"}},{"name":"MultiMediaPickerService","qualifiedName":"multi_media_pick_service.MultiMediaPickerService.MultiMediaPickerService","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"MultiMediaPickerService","type":"class","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md"}},{"name":"cropImage","qualifiedName":"multi_media_pick_service.MultiMediaPickerService.cropImage","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to crop the image selected by the user.","enclosedBy":{"name":"MultiMediaPickerService","type":"class","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md"}},{"name":"fileStream","qualifiedName":"multi_media_pick_service.MultiMediaPickerService.fileStream","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"This function returns the stream of files.","enclosedBy":{"name":"MultiMediaPickerService","type":"class","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md"}},{"name":"getPhotoFromGallery","qualifiedName":"multi_media_pick_service.MultiMediaPickerService.getPhotoFromGallery","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to pick the image from gallery or to click the image from user's camera.","enclosedBy":{"name":"MultiMediaPickerService","type":"class","href":"services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md"}},{"name":"navigation_service","qualifiedName":"navigation_service","href":"services_navigation_service/services_navigation_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"NavigationService","qualifiedName":"navigation_service.NavigationService","href":"services_navigation_service/NavigationService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"NavigationService class provides different functions as service in the context of navigation.","enclosedBy":{"name":"navigation_service","type":"library","href":"services_navigation_service/services_navigation_service-library.md"}},{"name":"NavigationService","qualifiedName":"navigation_service.NavigationService.NavigationService","href":"services_navigation_service/NavigationService/NavigationService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"fromInviteLink","qualifiedName":"navigation_service.NavigationService.fromInviteLink","href":"services_navigation_service/NavigationService/fromInviteLink.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"navigatorKey","qualifiedName":"navigation_service.NavigationService.navigatorKey","href":"services_navigation_service/NavigationService/navigatorKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"pop","qualifiedName":"navigation_service.NavigationService.pop","href":"services_navigation_service/NavigationService/pop.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function pops the current state.","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"popAndPushScreen","qualifiedName":"navigation_service.NavigationService.popAndPushScreen","href":"services_navigation_service/NavigationService/popAndPushScreen.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function pop the initial route and push the new route to the navigator.","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"pushDialog","qualifiedName":"navigation_service.NavigationService.pushDialog","href":"services_navigation_service/NavigationService/pushDialog.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to show the custom Dialog.","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"pushReplacementScreen","qualifiedName":"navigation_service.NavigationService.pushReplacementScreen","href":"services_navigation_service/NavigationService/pushReplacementScreen.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function push the route and replace the screen.","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"pushScreen","qualifiedName":"navigation_service.NavigationService.pushScreen","href":"services_navigation_service/NavigationService/pushScreen.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function push the route to the navigator.","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"removeAllAndPush","qualifiedName":"navigation_service.NavigationService.removeAllAndPush","href":"services_navigation_service/NavigationService/removeAllAndPush.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function remove all the routes till the particular route and add new route.","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"showSnackBar","qualifiedName":"navigation_service.NavigationService.showSnackBar","href":"services_navigation_service/NavigationService/showSnackBar.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This is used for the quick alert of duration: 2 seconds with text message(passed).","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"showTalawaErrorDialog","qualifiedName":"navigation_service.NavigationService.showTalawaErrorDialog","href":"services_navigation_service/NavigationService/showTalawaErrorDialog.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"showTalawaErrorSnackBar","qualifiedName":"navigation_service.NavigationService.showTalawaErrorSnackBar","href":"services_navigation_service/NavigationService/showTalawaErrorSnackBar.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NavigationService","type":"class","href":"services_navigation_service/NavigationService-class.md"}},{"name":"options","qualifiedName":"options","href":"models_options_options/models_options_options-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Options","qualifiedName":"options.Options","href":"models_options_options/Options-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates a Option model.","enclosedBy":{"name":"options","type":"library","href":"models_options_options/models_options_options-library.md"}},{"name":"Options","qualifiedName":"options.Options.Options","href":"models_options_options/Options/Options.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Options","type":"class","href":"models_options_options/Options-class.md"}},{"name":"icon","qualifiedName":"options.Options.icon","href":"models_options_options/Options/icon.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Options","type":"class","href":"models_options_options/Options-class.md"}},{"name":"subtitle","qualifiedName":"options.Options.subtitle","href":"models_options_options/Options/subtitle.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Options","type":"class","href":"models_options_options/Options-class.md"}},{"name":"title","qualifiedName":"options.Options.title","href":"models_options_options/Options/title.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Options","type":"class","href":"models_options_options/Options-class.md"}},{"name":"trailingIconButton","qualifiedName":"options.Options.trailingIconButton","href":"models_options_options/Options/trailingIconButton.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Options","type":"class","href":"models_options_options/Options-class.md"}},{"name":"org_info","qualifiedName":"org_info","href":"models_organization_org_info/models_organization_org_info-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"OrgInfo","qualifiedName":"org_info.OrgInfo","href":"models_organization_org_info/OrgInfo-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates an organization-information model and returns an OrgInfo instance.","enclosedBy":{"name":"org_info","type":"library","href":"models_organization_org_info/models_organization_org_info-library.md"}},{"name":"OrgInfo","qualifiedName":"org_info.OrgInfo.OrgInfo","href":"models_organization_org_info/OrgInfo/OrgInfo.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"admins","qualifiedName":"org_info.OrgInfo.admins","href":"models_organization_org_info/OrgInfo/admins.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"creatorInfo","qualifiedName":"org_info.OrgInfo.creatorInfo","href":"models_organization_org_info/OrgInfo/creatorInfo.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"description","qualifiedName":"org_info.OrgInfo.description","href":"models_organization_org_info/OrgInfo/description.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"OrgInfo.fromJson","qualifiedName":"org_info.OrgInfo.fromJson","href":"models_organization_org_info/OrgInfo/OrgInfo.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"fromJsonToList","qualifiedName":"org_info.OrgInfo.fromJsonToList","href":"models_organization_org_info/OrgInfo/fromJsonToList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"id","qualifiedName":"org_info.OrgInfo.id","href":"models_organization_org_info/OrgInfo/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"image","qualifiedName":"org_info.OrgInfo.image","href":"models_organization_org_info/OrgInfo/image.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"isPublic","qualifiedName":"org_info.OrgInfo.isPublic","href":"models_organization_org_info/OrgInfo/isPublic.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"members","qualifiedName":"org_info.OrgInfo.members","href":"models_organization_org_info/OrgInfo/members.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"name","qualifiedName":"org_info.OrgInfo.name","href":"models_organization_org_info/OrgInfo/name.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfo","type":"class","href":"models_organization_org_info/OrgInfo-class.md"}},{"name":"OrgInfoAdapter","qualifiedName":"org_info.OrgInfoAdapter","href":"models_organization_org_info/OrgInfoAdapter-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"org_info","type":"library","href":"models_organization_org_info/models_organization_org_info-library.md"}},{"name":"operator ==","qualifiedName":"org_info.OrgInfoAdapter.==","href":"models_organization_org_info/OrgInfoAdapter/operator_equals.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"The equality operator.","enclosedBy":{"name":"OrgInfoAdapter","type":"class","href":"models_organization_org_info/OrgInfoAdapter-class.md"}},{"name":"OrgInfoAdapter","qualifiedName":"org_info.OrgInfoAdapter.OrgInfoAdapter","href":"models_organization_org_info/OrgInfoAdapter/OrgInfoAdapter.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrgInfoAdapter","type":"class","href":"models_organization_org_info/OrgInfoAdapter-class.md"}},{"name":"hashCode","qualifiedName":"org_info.OrgInfoAdapter.hashCode","href":"models_organization_org_info/OrgInfoAdapter/hashCode.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"The hash code for this object.","enclosedBy":{"name":"OrgInfoAdapter","type":"class","href":"models_organization_org_info/OrgInfoAdapter-class.md"}},{"name":"read","qualifiedName":"org_info.OrgInfoAdapter.read","href":"models_organization_org_info/OrgInfoAdapter/read.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Is called when a value has to be decoded.","enclosedBy":{"name":"OrgInfoAdapter","type":"class","href":"models_organization_org_info/OrgInfoAdapter-class.md"}},{"name":"typeId","qualifiedName":"org_info.OrgInfoAdapter.typeId","href":"models_organization_org_info/OrgInfoAdapter/typeId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Called for type registration","enclosedBy":{"name":"OrgInfoAdapter","type":"class","href":"models_organization_org_info/OrgInfoAdapter-class.md"}},{"name":"write","qualifiedName":"org_info.OrgInfoAdapter.write","href":"models_organization_org_info/OrgInfoAdapter/write.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Is called when a value has to be encoded.","enclosedBy":{"name":"OrgInfoAdapter","type":"class","href":"models_organization_org_info/OrgInfoAdapter-class.md"}},{"name":"org_service","qualifiedName":"org_service","href":"services_org_service/services_org_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"OrganizationService","qualifiedName":"org_service.OrganizationService","href":"services_org_service/OrganizationService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"OrganizationService class provides the in the context of organizations.","enclosedBy":{"name":"org_service","type":"library","href":"services_org_service/services_org_service-library.md"}},{"name":"OrganizationService","qualifiedName":"org_service.OrganizationService.OrganizationService","href":"services_org_service/OrganizationService/OrganizationService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationService","type":"class","href":"services_org_service/OrganizationService-class.md"}},{"name":"getOrgMembersList","qualifiedName":"org_service.OrganizationService.getOrgMembersList","href":"services_org_service/OrganizationService/getOrgMembersList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch and returns the list of organization members.","enclosedBy":{"name":"OrganizationService","type":"class","href":"services_org_service/OrganizationService-class.md"}},{"name":"organization_feed","qualifiedName":"organization_feed","href":"views_after_auth_screens_feed_organization_feed/views_after_auth_screens_feed_organization_feed-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"OrganizationFeed","qualifiedName":"organization_feed.OrganizationFeed","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"OrganizationFeed returns a widget that shows the feed of the organization.","enclosedBy":{"name":"organization_feed","type":"library","href":"views_after_auth_screens_feed_organization_feed/views_after_auth_screens_feed_organization_feed-library.md"}},{"name":"OrganizationFeed","qualifiedName":"organization_feed.OrganizationFeed.OrganizationFeed","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeed","type":"class","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md"}},{"name":"build","qualifiedName":"organization_feed.OrganizationFeed.build","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"OrganizationFeed","type":"class","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md"}},{"name":"forTest","qualifiedName":"organization_feed.OrganizationFeed.forTest","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeed","type":"class","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md"}},{"name":"homeModel","qualifiedName":"organization_feed.OrganizationFeed.homeModel","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeed","type":"class","href":"views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md"}},{"name":"organization_feed_view_model","qualifiedName":"organization_feed_view_model","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"OrganizationFeedViewModel","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"OrganizationFeedViewModel class helps to interact with model to serve data to view for organization feed section.","enclosedBy":{"name":"organization_feed_view_model","type":"library","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model-library.md"}},{"name":"OrganizationFeedViewModel","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.OrganizationFeedViewModel","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/OrganizationFeedViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"addNewPost","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.addNewPost","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function adds new Post.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"buildNewPosts","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.buildNewPosts","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function initialise _posts with newPosts.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"currentOrgName","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.currentOrgName","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"dispose","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.dispose","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Discards any resources used by the object. After this is called, the\nobject is not in a usable state and should be discarded (calls to\naddListener will throw after the object is disposed).","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"fetchNewPosts","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.fetchNewPosts","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetches new posts in the organization.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"initialise","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.initialise","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"initializeWithDemoData","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.initializeWithDemoData","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"istest","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.istest","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"navigateToIndividualPage","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.navigateToIndividualPage","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function navigate to individual post page.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"navigateToPinnedPostPage","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.navigateToPinnedPostPage","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function navigate to pinned post page.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"pinnedPosts","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.pinnedPosts","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"posts","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.posts","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"setCurrentOrganizationName","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.setCurrentOrganizationName","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function sets the organization name after update.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"updatedPost","qualifiedName":"organization_feed_view_model.OrganizationFeedViewModel.updatedPost","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function updates the post.","enclosedBy":{"name":"OrganizationFeedViewModel","type":"class","href":"view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md"}},{"name":"organization_list","qualifiedName":"organization_list","href":"widgets_organization_list/widgets_organization_list-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"OrganizationList","qualifiedName":"organization_list.OrganizationList","href":"widgets_organization_list/OrganizationList-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns the OrganizationList widget.","enclosedBy":{"name":"organization_list","type":"library","href":"widgets_organization_list/widgets_organization_list-library.md"}},{"name":"OrganizationList","qualifiedName":"organization_list.OrganizationList.OrganizationList","href":"widgets_organization_list/OrganizationList/OrganizationList.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationList","type":"class","href":"widgets_organization_list/OrganizationList-class.md"}},{"name":"build","qualifiedName":"organization_list.OrganizationList.build","href":"widgets_organization_list/OrganizationList/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"OrganizationList","type":"class","href":"widgets_organization_list/OrganizationList-class.md"}},{"name":"model","qualifiedName":"organization_list.OrganizationList.model","href":"widgets_organization_list/OrganizationList/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"model is a type of SelectOrganizationViewModel which provides methods to handle the data for this component.","enclosedBy":{"name":"OrganizationList","type":"class","href":"widgets_organization_list/OrganizationList-class.md"}},{"name":"organization_search_list","qualifiedName":"organization_search_list","href":"widgets_organization_search_list/widgets_organization_search_list-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"OrganizationSearchList","qualifiedName":"organization_search_list.OrganizationSearchList","href":"widgets_organization_search_list/OrganizationSearchList-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"OrganizationSearchList class return a widget that shows all\nthe matching organizations searched on the search bar.","enclosedBy":{"name":"organization_search_list","type":"library","href":"widgets_organization_search_list/widgets_organization_search_list-library.md"}},{"name":"OrganizationSearchList","qualifiedName":"organization_search_list.OrganizationSearchList.OrganizationSearchList","href":"widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationSearchList","type":"class","href":"widgets_organization_search_list/OrganizationSearchList-class.md"}},{"name":"build","qualifiedName":"organization_search_list.OrganizationSearchList.build","href":"widgets_organization_search_list/OrganizationSearchList/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"OrganizationSearchList","type":"class","href":"widgets_organization_search_list/OrganizationSearchList-class.md"}},{"name":"model","qualifiedName":"organization_search_list.OrganizationSearchList.model","href":"widgets_organization_search_list/OrganizationSearchList/model.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"OrganizationSearchList","type":"class","href":"widgets_organization_search_list/OrganizationSearchList-class.md"}},{"name":"pinned_carousel_widget","qualifiedName":"pinned_carousel_widget","href":"widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomCarouselScroller","qualifiedName":"pinned_carousel_widget.CustomCarouselScroller","href":"widgets_pinned_carousel_widget/CustomCarouselScroller-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"pinned_carousel_widget","type":"library","href":"widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md"}},{"name":"CustomCarouselScroller","qualifiedName":"pinned_carousel_widget.CustomCarouselScroller.CustomCarouselScroller","href":"widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomCarouselScroller","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScroller-class.md"}},{"name":"createState","qualifiedName":"pinned_carousel_widget.CustomCarouselScroller.createState","href":"widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"CustomCarouselScroller","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScroller-class.md"}},{"name":"navigateToIndividualPostPage","qualifiedName":"pinned_carousel_widget.CustomCarouselScroller.navigateToIndividualPostPage","href":"widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomCarouselScroller","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScroller-class.md"}},{"name":"pinnedPosts","qualifiedName":"pinned_carousel_widget.CustomCarouselScroller.pinnedPosts","href":"widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomCarouselScroller","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScroller-class.md"}},{"name":"CustomCarouselScrollerState","qualifiedName":"pinned_carousel_widget.CustomCarouselScrollerState","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CustomCarouselScrollerState class return a widget that is\nused to generate slider for pinned post on the top of the Home Screen.","enclosedBy":{"name":"pinned_carousel_widget","type":"library","href":"widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md"}},{"name":"CustomCarouselScrollerState","qualifiedName":"pinned_carousel_widget.CustomCarouselScrollerState.CustomCarouselScrollerState","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState/CustomCarouselScrollerState.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomCarouselScrollerState","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md"}},{"name":"build","qualifiedName":"pinned_carousel_widget.CustomCarouselScrollerState.build","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomCarouselScrollerState","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md"}},{"name":"controller","qualifiedName":"pinned_carousel_widget.CustomCarouselScrollerState.controller","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomCarouselScrollerState","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md"}},{"name":"pindex","qualifiedName":"pinned_carousel_widget.CustomCarouselScrollerState.pindex","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomCarouselScrollerState","type":"class","href":"widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md"}},{"name":"PinnedPostCarousel","qualifiedName":"pinned_carousel_widget.PinnedPostCarousel","href":"widgets_pinned_carousel_widget/PinnedPostCarousel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"PinnedPostCarousel class returns a widget for pinned posts in\nthe slider/carousel on the top of the Home Screen.\nTapping on a post will redirect you to the respective post screen.","enclosedBy":{"name":"pinned_carousel_widget","type":"library","href":"widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md"}},{"name":"PinnedPostCarousel","qualifiedName":"pinned_carousel_widget.PinnedPostCarousel.PinnedPostCarousel","href":"widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PinnedPostCarousel","type":"class","href":"widgets_pinned_carousel_widget/PinnedPostCarousel-class.md"}},{"name":"build","qualifiedName":"pinned_carousel_widget.PinnedPostCarousel.build","href":"widgets_pinned_carousel_widget/PinnedPostCarousel/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"PinnedPostCarousel","type":"class","href":"widgets_pinned_carousel_widget/PinnedPostCarousel-class.md"}},{"name":"navigateToIndividualPostPage","qualifiedName":"pinned_carousel_widget.PinnedPostCarousel.navigateToIndividualPostPage","href":"widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PinnedPostCarousel","type":"class","href":"widgets_pinned_carousel_widget/PinnedPostCarousel-class.md"}},{"name":"navigateToPinnedPostPage","qualifiedName":"pinned_carousel_widget.PinnedPostCarousel.navigateToPinnedPostPage","href":"widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PinnedPostCarousel","type":"class","href":"widgets_pinned_carousel_widget/PinnedPostCarousel-class.md"}},{"name":"pinnedPosts","qualifiedName":"pinned_carousel_widget.PinnedPostCarousel.pinnedPosts","href":"widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PinnedPostCarousel","type":"class","href":"widgets_pinned_carousel_widget/PinnedPostCarousel-class.md"}},{"name":"pinned_post_demo_data","qualifiedName":"pinned_post_demo_data","href":"demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"pinnedPostsDemoData","qualifiedName":"pinned_post_demo_data.pinnedPostsDemoData","href":"demo_server_data_pinned_post_demo_data/pinnedPostsDemoData-constant.md","type":"top-level constant","overriddenDepth":0,"packageName":"talawa","desc":"This file contains demo data for pinned posts. It contains a list of type Map<String, Object> and sample data.","enclosedBy":{"name":"pinned_post_demo_data","type":"library","href":"demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md"}},{"name":"pinned_post_page","qualifiedName":"pinned_post_page","href":"views_after_auth_screens_feed_pinned_post_page/views_after_auth_screens_feed_pinned_post_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"PinnedPostPage","qualifiedName":"pinned_post_page.PinnedPostPage","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"PinnedPostPage returns a widget that shows the list of all the pinned post.","enclosedBy":{"name":"pinned_post_page","type":"library","href":"views_after_auth_screens_feed_pinned_post_page/views_after_auth_screens_feed_pinned_post_page-library.md"}},{"name":"PinnedPostPage","qualifiedName":"pinned_post_page.PinnedPostPage.PinnedPostPage","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PinnedPostPage","type":"class","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md"}},{"name":"build","qualifiedName":"pinned_post_page.PinnedPostPage.build","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"PinnedPostPage","type":"class","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md"}},{"name":"pinnedPosts","qualifiedName":"pinned_post_page.PinnedPostPage.pinnedPosts","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PinnedPostPage","type":"class","href":"views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md"}},{"name":"post_demo_data","qualifiedName":"post_demo_data","href":"demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"postsDemoData","qualifiedName":"post_demo_data.postsDemoData","href":"demo_server_data_post_demo_data/postsDemoData-constant.md","type":"top-level constant","overriddenDepth":0,"packageName":"talawa","desc":"This file contains demo data for posts. It contains a list of type Map<String, Object>\nand sample data of posts.","enclosedBy":{"name":"post_demo_data","type":"library","href":"demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md"}},{"name":"post_detailed_page","qualifiedName":"post_detailed_page","href":"widgets_post_detailed_page/widgets_post_detailed_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DescriptionTextWidget","qualifiedName":"post_detailed_page.DescriptionTextWidget","href":"widgets_post_detailed_page/DescriptionTextWidget-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class sets up the post page.\nTo implement the \"show less\" and \"show more\" functions for the text,\nwe divide the text into two parts: firstHalf and secondHalf. A flag is set to\ntrack whether to display either the firstHalf or both(the entire text).","enclosedBy":{"name":"post_detailed_page","type":"library","href":"widgets_post_detailed_page/widgets_post_detailed_page-library.md"}},{"name":"DescriptionTextWidget","qualifiedName":"post_detailed_page.DescriptionTextWidget.DescriptionTextWidget","href":"widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DescriptionTextWidget","type":"class","href":"widgets_post_detailed_page/DescriptionTextWidget-class.md"}},{"name":"createState","qualifiedName":"post_detailed_page.DescriptionTextWidget.createState","href":"widgets_post_detailed_page/DescriptionTextWidget/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"DescriptionTextWidget","type":"class","href":"widgets_post_detailed_page/DescriptionTextWidget-class.md"}},{"name":"text","qualifiedName":"post_detailed_page.DescriptionTextWidget.text","href":"widgets_post_detailed_page/DescriptionTextWidget/text.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DescriptionTextWidget","type":"class","href":"widgets_post_detailed_page/DescriptionTextWidget-class.md"}},{"name":"post_list_widget","qualifiedName":"post_list_widget","href":"widgets_post_list_widget/widgets_post_list_widget-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"PostListWidget","qualifiedName":"post_list_widget.PostListWidget","href":"widgets_post_list_widget/PostListWidget-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class receives a List of all the Post widgets and returns a ListView.","enclosedBy":{"name":"post_list_widget","type":"library","href":"widgets_post_list_widget/widgets_post_list_widget-library.md"}},{"name":"PostListWidget","qualifiedName":"post_list_widget.PostListWidget.PostListWidget","href":"widgets_post_list_widget/PostListWidget/PostListWidget.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostListWidget","type":"class","href":"widgets_post_list_widget/PostListWidget-class.md"}},{"name":"build","qualifiedName":"post_list_widget.PostListWidget.build","href":"widgets_post_list_widget/PostListWidget/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"PostListWidget","type":"class","href":"widgets_post_list_widget/PostListWidget-class.md"}},{"name":"function","qualifiedName":"post_list_widget.PostListWidget.function","href":"widgets_post_list_widget/PostListWidget/function.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostListWidget","type":"class","href":"widgets_post_list_widget/PostListWidget-class.md"}},{"name":"posts","qualifiedName":"post_list_widget.PostListWidget.posts","href":"widgets_post_list_widget/PostListWidget/posts.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostListWidget","type":"class","href":"widgets_post_list_widget/PostListWidget-class.md"}},{"name":"post_model","qualifiedName":"post_model","href":"models_post_post_model/models_post_post_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Comments","qualifiedName":"post_model.Comments","href":"models_post_post_model/Comments-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class convert between json and object for comments.","enclosedBy":{"name":"post_model","type":"library","href":"models_post_post_model/models_post_post_model-library.md"}},{"name":"Comments","qualifiedName":"post_model.Comments.Comments","href":"models_post_post_model/Comments/Comments.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Comments","type":"class","href":"models_post_post_model/Comments-class.md"}},{"name":"Comments.fromJson","qualifiedName":"post_model.Comments.fromJson","href":"models_post_post_model/Comments/Comments.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"Convert json to dart object.","enclosedBy":{"name":"Comments","type":"class","href":"models_post_post_model/Comments-class.md"}},{"name":"sId","qualifiedName":"post_model.Comments.sId","href":"models_post_post_model/Comments/sId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"these are dart object.","enclosedBy":{"name":"Comments","type":"class","href":"models_post_post_model/Comments-class.md"}},{"name":"toJson","qualifiedName":"post_model.Comments.toJson","href":"models_post_post_model/Comments/toJson.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Convert dart object to json.","enclosedBy":{"name":"Comments","type":"class","href":"models_post_post_model/Comments-class.md"}},{"name":"LikedBy","qualifiedName":"post_model.LikedBy","href":"models_post_post_model/LikedBy-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class convert between json and object for likedby.","enclosedBy":{"name":"post_model","type":"library","href":"models_post_post_model/models_post_post_model-library.md"}},{"name":"LikedBy","qualifiedName":"post_model.LikedBy.LikedBy","href":"models_post_post_model/LikedBy/LikedBy.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"LikedBy","type":"class","href":"models_post_post_model/LikedBy-class.md"}},{"name":"LikedBy.fromJson","qualifiedName":"post_model.LikedBy.fromJson","href":"models_post_post_model/LikedBy/LikedBy.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"JSON factory constructor.","enclosedBy":{"name":"LikedBy","type":"class","href":"models_post_post_model/LikedBy-class.md"}},{"name":"sId","qualifiedName":"post_model.LikedBy.sId","href":"models_post_post_model/LikedBy/sId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"These are dart object.","enclosedBy":{"name":"LikedBy","type":"class","href":"models_post_post_model/LikedBy-class.md"}},{"name":"toJson","qualifiedName":"post_model.LikedBy.toJson","href":"models_post_post_model/LikedBy/toJson.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Convert dart object to json.","enclosedBy":{"name":"LikedBy","type":"class","href":"models_post_post_model/LikedBy-class.md"}},{"name":"Post","qualifiedName":"post_model.Post","href":"models_post_post_model/Post-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates a Post model.","enclosedBy":{"name":"post_model","type":"library","href":"models_post_post_model/models_post_post_model-library.md"}},{"name":"Post","qualifiedName":"post_model.Post.Post","href":"models_post_post_model/Post/Post.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"comments","qualifiedName":"post_model.Post.comments","href":"models_post_post_model/Post/comments.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"comments for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"createdAt","qualifiedName":"post_model.Post.createdAt","href":"models_post_post_model/Post/createdAt.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"createdAt for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"creator","qualifiedName":"post_model.Post.creator","href":"models_post_post_model/Post/creator.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"creator for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"description","qualifiedName":"post_model.Post.description","href":"models_post_post_model/Post/description.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"description for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"Post.fromJson","qualifiedName":"post_model.Post.fromJson","href":"models_post_post_model/Post/Post.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"Creating a new Post instance from a map structure.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"getPostCreatedDuration","qualifiedName":"post_model.Post.getPostCreatedDuration","href":"models_post_post_model/Post/getPostCreatedDuration.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"this is to get duration of post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"imageUrl","qualifiedName":"post_model.Post.imageUrl","href":"models_post_post_model/Post/imageUrl.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"imageUrl for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"likedBy","qualifiedName":"post_model.Post.likedBy","href":"models_post_post_model/Post/likedBy.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"likedBy for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"organization","qualifiedName":"post_model.Post.organization","href":"models_post_post_model/Post/organization.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"organization for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"sId","qualifiedName":"post_model.Post.sId","href":"models_post_post_model/Post/sId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"unique identifier for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"videoUrl","qualifiedName":"post_model.Post.videoUrl","href":"models_post_post_model/Post/videoUrl.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"videoUrl for post.","enclosedBy":{"name":"Post","type":"class","href":"models_post_post_model/Post-class.md"}},{"name":"post_queries","qualifiedName":"post_queries","href":"utils_post_queries/utils_post_queries-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"PostQueries","qualifiedName":"post_queries.PostQueries","href":"utils_post_queries/PostQueries-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates queries related to posts.","enclosedBy":{"name":"post_queries","type":"library","href":"utils_post_queries/utils_post_queries-library.md"}},{"name":"PostQueries","qualifiedName":"post_queries.PostQueries.PostQueries","href":"utils_post_queries/PostQueries/PostQueries.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostQueries","type":"class","href":"utils_post_queries/PostQueries-class.md"}},{"name":"addLike","qualifiedName":"post_queries.PostQueries.addLike","href":"utils_post_queries/PostQueries/addLike.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Add Like to a post.","enclosedBy":{"name":"PostQueries","type":"class","href":"utils_post_queries/PostQueries-class.md"}},{"name":"getPostsById","qualifiedName":"post_queries.PostQueries.getPostsById","href":"utils_post_queries/PostQueries/getPostsById.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Getting Posts by Id.","enclosedBy":{"name":"PostQueries","type":"class","href":"utils_post_queries/PostQueries-class.md"}},{"name":"removeLike","qualifiedName":"post_queries.PostQueries.removeLike","href":"utils_post_queries/PostQueries/removeLike.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Remove Like from a post.","enclosedBy":{"name":"PostQueries","type":"class","href":"utils_post_queries/PostQueries-class.md"}},{"name":"uploadPost","qualifiedName":"post_queries.PostQueries.uploadPost","href":"utils_post_queries/PostQueries/uploadPost.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"Upload a post to database.","enclosedBy":{"name":"PostQueries","type":"class","href":"utils_post_queries/PostQueries-class.md"}},{"name":"post_service","qualifiedName":"post_service","href":"services_post_service/services_post_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"PostService","qualifiedName":"post_service.PostService","href":"services_post_service/PostService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"PostService class provides functions in the context of a Post.","enclosedBy":{"name":"post_service","type":"library","href":"services_post_service/services_post_service-library.md"}},{"name":"PostService","qualifiedName":"post_service.PostService.PostService","href":"services_post_service/PostService/PostService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"addCommentLocally","qualifiedName":"post_service.PostService.addCommentLocally","href":"services_post_service/PostService/addCommentLocally.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"addLike","qualifiedName":"post_service.PostService.addLike","href":"services_post_service/PostService/addLike.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to add Like to the Post.","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"getPosts","qualifiedName":"post_service.PostService.getPosts","href":"services_post_service/PostService/getPosts.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function used to get all posts of an organization.\nThe function reference the organization Id from _currentOrg.","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"postStream","qualifiedName":"post_service.PostService.postStream","href":"services_post_service/PostService/postStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"removeLike","qualifiedName":"post_service.PostService.removeLike","href":"services_post_service/PostService/removeLike.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to remove like from the Post.","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"setOrgStreamSubscription","qualifiedName":"post_service.PostService.setOrgStreamSubscription","href":"services_post_service/PostService/setOrgStreamSubscription.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"updatedPostStream","qualifiedName":"post_service.PostService.updatedPostStream","href":"services_post_service/PostService/updatedPostStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostService","type":"class","href":"services_post_service/PostService-class.md"}},{"name":"post_widget","qualifiedName":"post_widget","href":"widgets_post_widget/widgets_post_widget-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"NewsPost","qualifiedName":"post_widget.NewsPost","href":"widgets_post_widget/NewsPost-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"post_widget","type":"library","href":"widgets_post_widget/widgets_post_widget-library.md"}},{"name":"NewsPost","qualifiedName":"post_widget.NewsPost.NewsPost","href":"widgets_post_widget/NewsPost/NewsPost.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NewsPost","type":"class","href":"widgets_post_widget/NewsPost-class.md"}},{"name":"build","qualifiedName":"post_widget.NewsPost.build","href":"widgets_post_widget/NewsPost/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"NewsPost","type":"class","href":"widgets_post_widget/NewsPost-class.md"}},{"name":"function","qualifiedName":"post_widget.NewsPost.function","href":"widgets_post_widget/NewsPost/function.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NewsPost","type":"class","href":"widgets_post_widget/NewsPost-class.md"}},{"name":"post","qualifiedName":"post_widget.NewsPost.post","href":"widgets_post_widget/NewsPost/post.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"NewsPost","type":"class","href":"widgets_post_widget/NewsPost-class.md"}},{"name":"PostContainer","qualifiedName":"post_widget.PostContainer","href":"widgets_post_widget/PostContainer-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"post_widget","type":"library","href":"widgets_post_widget/widgets_post_widget-library.md"}},{"name":"PostContainer","qualifiedName":"post_widget.PostContainer.PostContainer","href":"widgets_post_widget/PostContainer/PostContainer.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainer","type":"class","href":"widgets_post_widget/PostContainer-class.md"}},{"name":"createState","qualifiedName":"post_widget.PostContainer.createState","href":"widgets_post_widget/PostContainer/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"PostContainer","type":"class","href":"widgets_post_widget/PostContainer-class.md"}},{"name":"id","qualifiedName":"post_widget.PostContainer.id","href":"widgets_post_widget/PostContainer/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainer","type":"class","href":"widgets_post_widget/PostContainer-class.md"}},{"name":"PostContainerState","qualifiedName":"post_widget.PostContainerState","href":"widgets_post_widget/PostContainerState-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"post_widget","type":"library","href":"widgets_post_widget/widgets_post_widget-library.md"}},{"name":"PostContainerState","qualifiedName":"post_widget.PostContainerState.PostContainerState","href":"widgets_post_widget/PostContainerState/PostContainerState.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"build","qualifiedName":"post_widget.PostContainerState.build","href":"widgets_post_widget/PostContainerState/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"controller","qualifiedName":"post_widget.PostContainerState.controller","href":"widgets_post_widget/PostContainerState/controller.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"dispose","qualifiedName":"post_widget.PostContainerState.dispose","href":"widgets_post_widget/PostContainerState/dispose.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called when this object is removed from the tree permanently.","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"inView","qualifiedName":"post_widget.PostContainerState.inView","href":"widgets_post_widget/PostContainerState/inView.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"initState","qualifiedName":"post_widget.PostContainerState.initState","href":"widgets_post_widget/PostContainerState/initState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called when this object is inserted into the tree.","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"pindex","qualifiedName":"post_widget.PostContainerState.pindex","href":"widgets_post_widget/PostContainerState/pindex.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"startedPlaying","qualifiedName":"post_widget.PostContainerState.startedPlaying","href":"widgets_post_widget/PostContainerState/startedPlaying.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"PostContainerState","type":"class","href":"widgets_post_widget/PostContainerState-class.md"}},{"name":"profile_page","qualifiedName":"profile_page","href":"views_after_auth_screens_profile_profile_page/views_after_auth_screens_profile_profile_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ProfilePage","qualifiedName":"profile_page.ProfilePage","href":"views_after_auth_screens_profile_profile_page/ProfilePage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ProfilePage returns a widget that renders a page of user's profile.","enclosedBy":{"name":"profile_page","type":"library","href":"views_after_auth_screens_profile_profile_page/views_after_auth_screens_profile_profile_page-library.md"}},{"name":"ProfilePage","qualifiedName":"profile_page.ProfilePage.ProfilePage","href":"views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePage","type":"class","href":"views_after_auth_screens_profile_profile_page/ProfilePage-class.md"}},{"name":"build","qualifiedName":"profile_page.ProfilePage.build","href":"views_after_auth_screens_profile_profile_page/ProfilePage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"ProfilePage","type":"class","href":"views_after_auth_screens_profile_profile_page/ProfilePage-class.md"}},{"name":"donate","qualifiedName":"profile_page.ProfilePage.donate","href":"views_after_auth_screens_profile_profile_page/ProfilePage/donate.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePage","type":"class","href":"views_after_auth_screens_profile_profile_page/ProfilePage-class.md"}},{"name":"homeModel","qualifiedName":"profile_page.ProfilePage.homeModel","href":"views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePage","type":"class","href":"views_after_auth_screens_profile_profile_page/ProfilePage-class.md"}},{"name":"profile_page_view_model","qualifiedName":"profile_page_view_model","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/view_model_after_auth_view_models_profile_view_models_profile_page_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ProfilePageViewModel","qualifiedName":"profile_page_view_model.ProfilePageViewModel","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ProfilePageViewModel class helps to interact with model to serve data\nand react to user's input in Profile Page view.","enclosedBy":{"name":"profile_page_view_model","type":"library","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/view_model_after_auth_view_models_profile_view_models_profile_page_view_model-library.md"}},{"name":"ProfilePageViewModel","qualifiedName":"profile_page_view_model.ProfilePageViewModel.ProfilePageViewModel","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/ProfilePageViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"attachListener","qualifiedName":"profile_page_view_model.ProfilePageViewModel.attachListener","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"bottomSheetHeight","qualifiedName":"profile_page_view_model.ProfilePageViewModel.bottomSheetHeight","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"changeCurrency","qualifiedName":"profile_page_view_model.ProfilePageViewModel.changeCurrency","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This method changes the currency of the user for donation purpose.","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"currentOrg","qualifiedName":"profile_page_view_model.ProfilePageViewModel.currentOrg","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"currentUser","qualifiedName":"profile_page_view_model.ProfilePageViewModel.currentUser","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"denomination","qualifiedName":"profile_page_view_model.ProfilePageViewModel.denomination","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"dominationButton","qualifiedName":"profile_page_view_model.ProfilePageViewModel.dominationButton","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This widget returns button for domination.","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"donationAmount","qualifiedName":"profile_page_view_model.ProfilePageViewModel.donationAmount","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"donationCurrency","qualifiedName":"profile_page_view_model.ProfilePageViewModel.donationCurrency","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"donationCurrencySymbol","qualifiedName":"profile_page_view_model.ProfilePageViewModel.donationCurrencySymbol","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"donationField","qualifiedName":"profile_page_view_model.ProfilePageViewModel.donationField","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"iconButton","qualifiedName":"profile_page_view_model.ProfilePageViewModel.iconButton","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This widget returns the button for social media sharing option.","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"initialize","qualifiedName":"profile_page_view_model.ProfilePageViewModel.initialize","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"invite","qualifiedName":"profile_page_view_model.ProfilePageViewModel.invite","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function generates the organization invitation link in a Dialog Box.\nDialog box contains the QR-code of organization invite link and social media sharing options.","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"logout","qualifiedName":"profile_page_view_model.ProfilePageViewModel.logout","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This method destroys the user's session or sign out the user from app.\nThe function asks for the confimation in Custom Alert Dialog.","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"organisation","qualifiedName":"profile_page_view_model.ProfilePageViewModel.organisation","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"popBottomSheet","qualifiedName":"profile_page_view_model.ProfilePageViewModel.popBottomSheet","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"scaffoldKey","qualifiedName":"profile_page_view_model.ProfilePageViewModel.scaffoldKey","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"showSnackBar","qualifiedName":"profile_page_view_model.ProfilePageViewModel.showSnackBar","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"updateSheetHeight","qualifiedName":"profile_page_view_model.ProfilePageViewModel.updateSheetHeight","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"url","qualifiedName":"profile_page_view_model.ProfilePageViewModel.url","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"user","qualifiedName":"profile_page_view_model.ProfilePageViewModel.user","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProfilePageViewModel","type":"class","href":"view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md"}},{"name":"progress_dialog_view_model","qualifiedName":"progress_dialog_view_model","href":"view_model_widgets_view_models_progress_dialog_view_model/view_model_widgets_view_models_progress_dialog_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ProgressDialogViewModel","qualifiedName":"progress_dialog_view_model.ProgressDialogViewModel","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"ProgressDialogViewModel class helps to serve the data and\nto react to user's input for Progress Dialog Widget.","enclosedBy":{"name":"progress_dialog_view_model","type":"library","href":"view_model_widgets_view_models_progress_dialog_view_model/view_model_widgets_view_models_progress_dialog_view_model-library.md"}},{"name":"ProgressDialogViewModel","qualifiedName":"progress_dialog_view_model.ProgressDialogViewModel.ProgressDialogViewModel","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/ProgressDialogViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProgressDialogViewModel","type":"class","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md"}},{"name":"connectivityPresent","qualifiedName":"progress_dialog_view_model.ProgressDialogViewModel.connectivityPresent","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProgressDialogViewModel","type":"class","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md"}},{"name":"connectivityResult","qualifiedName":"progress_dialog_view_model.ProgressDialogViewModel.connectivityResult","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProgressDialogViewModel","type":"class","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md"}},{"name":"initialise","qualifiedName":"progress_dialog_view_model.ProgressDialogViewModel.initialise","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ProgressDialogViewModel","type":"class","href":"view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md"}},{"name":"queries","qualifiedName":"queries","href":"utils_queries/utils_queries-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Queries","qualifiedName":"queries.Queries","href":"utils_queries/Queries-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns some queries for the application.","enclosedBy":{"name":"queries","type":"library","href":"utils_queries/utils_queries-library.md"}},{"name":"Queries","qualifiedName":"queries.Queries.Queries","href":"utils_queries/Queries/Queries.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"createDonation","qualifiedName":"queries.Queries.createDonation","href":"utils_queries/Queries/createDonation.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"createDonation creates a new donation transaction by taking the userId ,orgId ,nameOfOrg ,nameOfUser as parameters","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"fetchJoinInOrg","qualifiedName":"queries.Queries.fetchJoinInOrg","href":"utils_queries/Queries/fetchJoinInOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"fetchJoinInOrgByName","qualifiedName":"queries.Queries.fetchJoinInOrgByName","href":"utils_queries/Queries/fetchJoinInOrgByName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"fetchOrgById","qualifiedName":"queries.Queries.fetchOrgById","href":"utils_queries/Queries/fetchOrgById.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"fetchOrgDetailsById","qualifiedName":"queries.Queries.fetchOrgDetailsById","href":"utils_queries/Queries/fetchOrgDetailsById.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"fetchUserInfo","qualifiedName":"queries.Queries.fetchUserInfo","href":"utils_queries/Queries/fetchUserInfo.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"getPluginsList","qualifiedName":"queries.Queries.getPluginsList","href":"utils_queries/Queries/getPluginsList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"getPluginList queries all properties of pluginList from the server","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"joinOrgById","qualifiedName":"queries.Queries.joinOrgById","href":"utils_queries/Queries/joinOrgById.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"loginUser","qualifiedName":"queries.Queries.loginUser","href":"utils_queries/Queries/loginUser.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"logout","qualifiedName":"queries.Queries.logout","href":"utils_queries/Queries/logout.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"newUserLanguage","qualifiedName":"queries.Queries.newUserLanguage","href":"utils_queries/Queries/newUserLanguage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"refreshToken","qualifiedName":"queries.Queries.refreshToken","href":"utils_queries/Queries/refreshToken.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"registerUser","qualifiedName":"queries.Queries.registerUser","href":"utils_queries/Queries/registerUser.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"saveFcmToken","qualifiedName":"queries.Queries.saveFcmToken","href":"utils_queries/Queries/saveFcmToken.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"sendMembershipRequest","qualifiedName":"queries.Queries.sendMembershipRequest","href":"utils_queries/Queries/sendMembershipRequest.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"updateLanguage","qualifiedName":"queries.Queries.updateLanguage","href":"utils_queries/Queries/updateLanguage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"userLanguage","qualifiedName":"queries.Queries.userLanguage","href":"utils_queries/Queries/userLanguage.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Queries","type":"class","href":"utils_queries/Queries-class.md"}},{"name":"quick_actions","qualifiedName":"quick_actions","href":"constants_quick_actions/constants_quick_actions-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ShortCutMenu","qualifiedName":"quick_actions.ShortCutMenu","href":"constants_quick_actions/ShortCutMenu-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This file contains the shortcuts by which user can manage and interact with the\napplication. quick_actions package is used for this purpose.","enclosedBy":{"name":"quick_actions","type":"library","href":"constants_quick_actions/constants_quick_actions-library.md"}},{"name":"ShortCutMenu","qualifiedName":"quick_actions.ShortCutMenu.ShortCutMenu","href":"constants_quick_actions/ShortCutMenu/ShortCutMenu.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ShortCutMenu","type":"class","href":"constants_quick_actions/ShortCutMenu-class.md"}},{"name":"chatAction","qualifiedName":"quick_actions.ShortCutMenu.chatAction","href":"constants_quick_actions/ShortCutMenu/chatAction-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ShortCutMenu","type":"class","href":"constants_quick_actions/ShortCutMenu-class.md"}},{"name":"eventAction","qualifiedName":"quick_actions.ShortCutMenu.eventAction","href":"constants_quick_actions/ShortCutMenu/eventAction-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ShortCutMenu","type":"class","href":"constants_quick_actions/ShortCutMenu-class.md"}},{"name":"feedAction","qualifiedName":"quick_actions.ShortCutMenu.feedAction","href":"constants_quick_actions/ShortCutMenu/feedAction-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ShortCutMenu","type":"class","href":"constants_quick_actions/ShortCutMenu-class.md"}},{"name":"quickActionsList","qualifiedName":"quick_actions.ShortCutMenu.quickActionsList","href":"constants_quick_actions/ShortCutMenu/quickActionsList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ShortCutMenu","type":"class","href":"constants_quick_actions/ShortCutMenu-class.md"}},{"name":"raised_round_edge_button","qualifiedName":"raised_round_edge_button","href":"widgets_raised_round_edge_button/widgets_raised_round_edge_button-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"RaisedRoundedButton","qualifiedName":"raised_round_edge_button.RaisedRoundedButton","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns a widget for a raised rounded button,\nfor example: login button in login screen.","enclosedBy":{"name":"raised_round_edge_button","type":"library","href":"widgets_raised_round_edge_button/widgets_raised_round_edge_button-library.md"}},{"name":"RaisedRoundedButton","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.RaisedRoundedButton","href":"widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"backgroundColor","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.backgroundColor","href":"widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"buttonLabel","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.buttonLabel","href":"widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"createState","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.createState","href":"widgets_raised_round_edge_button/RaisedRoundedButton/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"height","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.height","href":"widgets_raised_round_edge_button/RaisedRoundedButton/height.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"onTap","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.onTap","href":"widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"showArrow","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.showArrow","href":"widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"textColor","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.textColor","href":"widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"width","qualifiedName":"raised_round_edge_button.RaisedRoundedButton.width","href":"widgets_raised_round_edge_button/RaisedRoundedButton/width.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"RaisedRoundedButton","type":"class","href":"widgets_raised_round_edge_button/RaisedRoundedButton-class.md"}},{"name":"recover","qualifiedName":"recover","href":"views_pre_auth_screens_recover/views_pre_auth_screens_recover-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Recover","qualifiedName":"recover.Recover","href":"views_pre_auth_screens_recover/Recover-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class recovers the users password.\nThe users needs to enter his/her email and press on the button at the bottom to recover his/her password.","enclosedBy":{"name":"recover","type":"library","href":"views_pre_auth_screens_recover/views_pre_auth_screens_recover-library.md"}},{"name":"Recover","qualifiedName":"recover.Recover.Recover","href":"views_pre_auth_screens_recover/Recover/Recover.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Recover","type":"class","href":"views_pre_auth_screens_recover/Recover-class.md"}},{"name":"createState","qualifiedName":"recover.Recover.createState","href":"views_pre_auth_screens_recover/Recover/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"Recover","type":"class","href":"views_pre_auth_screens_recover/Recover-class.md"}},{"name":"rich_text","qualifiedName":"rich_text","href":"widgets_rich_text/widgets_rich_text-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"CustomRichText","qualifiedName":"rich_text.CustomRichText","href":"widgets_rich_text/CustomRichText-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"CustomRichText class returns a widget for customized rich/bold text.\nThese rich text are being used in form for changing the password.","enclosedBy":{"name":"rich_text","type":"library","href":"widgets_rich_text/widgets_rich_text-library.md"}},{"name":"CustomRichText","qualifiedName":"rich_text.CustomRichText.CustomRichText","href":"widgets_rich_text/CustomRichText/CustomRichText.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomRichText","type":"class","href":"widgets_rich_text/CustomRichText-class.md"}},{"name":"build","qualifiedName":"rich_text.CustomRichText.build","href":"widgets_rich_text/CustomRichText/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"CustomRichText","type":"class","href":"widgets_rich_text/CustomRichText-class.md"}},{"name":"words","qualifiedName":"rich_text.CustomRichText.words","href":"widgets_rich_text/CustomRichText/words.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"CustomRichText","type":"class","href":"widgets_rich_text/CustomRichText-class.md"}},{"name":"router","qualifiedName":"router","href":"router/router-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"generateRoute","qualifiedName":"router.generateRoute","href":"router/generateRoute.md","type":"function","overriddenDepth":0,"packageName":"talawa","desc":"The MaterialApp provides us with a property called generateRoute where\nwe can pass in a Function that returns a Route and takes in RouteSettings","enclosedBy":{"name":"router","type":"library","href":"router/router-library.md"}},{"name":"routing_constants","qualifiedName":"routing_constants","href":"constants_routing_constants/constants_routing_constants-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Routes","qualifiedName":"routing_constants.Routes","href":"constants_routing_constants/Routes-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This file contains the routes. These can be used to make push screen call via Routes.splashScreen to access these string.","enclosedBy":{"name":"routing_constants","type":"library","href":"constants_routing_constants/constants_routing_constants-library.md"}},{"name":"Routes","qualifiedName":"routing_constants.Routes.Routes","href":"constants_routing_constants/Routes/Routes.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"addTask","qualifiedName":"routing_constants.Routes.addTask","href":"constants_routing_constants/Routes/addTask-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"appSettings","qualifiedName":"routing_constants.Routes.appSettings","href":"constants_routing_constants/Routes/appSettings-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"calendar","qualifiedName":"routing_constants.Routes.calendar","href":"constants_routing_constants/Routes/calendar-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"chatMessageScreen","qualifiedName":"routing_constants.Routes.chatMessageScreen","href":"constants_routing_constants/Routes/chatMessageScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"createEventPage","qualifiedName":"routing_constants.Routes.createEventPage","href":"constants_routing_constants/Routes/createEventPage-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"demoPageViewRoute","qualifiedName":"routing_constants.Routes.demoPageViewRoute","href":"constants_routing_constants/Routes/demoPageViewRoute-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"editEventPage","qualifiedName":"routing_constants.Routes.editEventPage","href":"constants_routing_constants/Routes/editEventPage-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"editProfilePage","qualifiedName":"routing_constants.Routes.editProfilePage","href":"constants_routing_constants/Routes/editProfilePage-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"editTask","qualifiedName":"routing_constants.Routes.editTask","href":"constants_routing_constants/Routes/editTask-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"eventInfoPage","qualifiedName":"routing_constants.Routes.eventInfoPage","href":"constants_routing_constants/Routes/eventInfoPage-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"eventTasks","qualifiedName":"routing_constants.Routes.eventTasks","href":"constants_routing_constants/Routes/eventTasks-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"exploreEventsScreen","qualifiedName":"routing_constants.Routes.exploreEventsScreen","href":"constants_routing_constants/Routes/exploreEventsScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"homeScreen","qualifiedName":"routing_constants.Routes.homeScreen","href":"constants_routing_constants/Routes/homeScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"individualPost","qualifiedName":"routing_constants.Routes.individualPost","href":"constants_routing_constants/Routes/individualPost-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"joinOrg","qualifiedName":"routing_constants.Routes.joinOrg","href":"constants_routing_constants/Routes/joinOrg-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"languageSelectionRoute","qualifiedName":"routing_constants.Routes.languageSelectionRoute","href":"constants_routing_constants/Routes/languageSelectionRoute-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"loginScreen","qualifiedName":"routing_constants.Routes.loginScreen","href":"constants_routing_constants/Routes/loginScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"mainScreen","qualifiedName":"routing_constants.Routes.mainScreen","href":"constants_routing_constants/Routes/mainScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"mapScreen","qualifiedName":"routing_constants.Routes.mapScreen","href":"constants_routing_constants/Routes/mapScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"pinnedPostPage","qualifiedName":"routing_constants.Routes.pinnedPostPage","href":"constants_routing_constants/Routes/pinnedPostPage-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"profilePage","qualifiedName":"routing_constants.Routes.profilePage","href":"constants_routing_constants/Routes/profilePage-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"progressDialog","qualifiedName":"routing_constants.Routes.progressDialog","href":"constants_routing_constants/Routes/progressDialog-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"recoverScreen","qualifiedName":"routing_constants.Routes.recoverScreen","href":"constants_routing_constants/Routes/recoverScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"requestAccess","qualifiedName":"routing_constants.Routes.requestAccess","href":"constants_routing_constants/Routes/requestAccess-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"selectContact","qualifiedName":"routing_constants.Routes.selectContact","href":"constants_routing_constants/Routes/selectContact-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"selectOrgScreen","qualifiedName":"routing_constants.Routes.selectOrgScreen","href":"constants_routing_constants/Routes/selectOrgScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"setUrlScreen","qualifiedName":"routing_constants.Routes.setUrlScreen","href":"constants_routing_constants/Routes/setUrlScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"signupDetailScreen","qualifiedName":"routing_constants.Routes.signupDetailScreen","href":"constants_routing_constants/Routes/signupDetailScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"splashScreen","qualifiedName":"routing_constants.Routes.splashScreen","href":"constants_routing_constants/Routes/splashScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"updateScreen","qualifiedName":"routing_constants.Routes.updateScreen","href":"constants_routing_constants/Routes/updateScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"userTasks","qualifiedName":"routing_constants.Routes.userTasks","href":"constants_routing_constants/Routes/userTasks-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"waitingScreen","qualifiedName":"routing_constants.Routes.waitingScreen","href":"constants_routing_constants/Routes/waitingScreen-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"static variables.","enclosedBy":{"name":"Routes","type":"class","href":"constants_routing_constants/Routes-class.md"}},{"name":"select_contact","qualifiedName":"select_contact","href":"views_after_auth_screens_chat_select_contact/views_after_auth_screens_chat_select_contact-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SelectContact","qualifiedName":"select_contact.SelectContact","href":"views_after_auth_screens_chat_select_contact/SelectContact-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"SelectContact returns a widget that has mutable state _SelectContactState.","enclosedBy":{"name":"select_contact","type":"library","href":"views_after_auth_screens_chat_select_contact/views_after_auth_screens_chat_select_contact-library.md"}},{"name":"SelectContact","qualifiedName":"select_contact.SelectContact.SelectContact","href":"views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectContact","type":"class","href":"views_after_auth_screens_chat_select_contact/SelectContact-class.md"}},{"name":"createState","qualifiedName":"select_contact.SelectContact.createState","href":"views_after_auth_screens_chat_select_contact/SelectContact/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"SelectContact","type":"class","href":"views_after_auth_screens_chat_select_contact/SelectContact-class.md"}},{"name":"select_contact_view_model","qualifiedName":"select_contact_view_model","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/view_model_after_auth_view_models_chat_view_models_select_contact_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SelectContactViewModel","qualifiedName":"select_contact_view_model.SelectContactViewModel","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"SelectContactViewModel class have different functions to interact with model.","enclosedBy":{"name":"select_contact_view_model","type":"library","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/view_model_after_auth_view_models_chat_view_models_select_contact_view_model-library.md"}},{"name":"SelectContactViewModel","qualifiedName":"select_contact_view_model.SelectContactViewModel.SelectContactViewModel","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/SelectContactViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectContactViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md"}},{"name":"getCurrentOrgUsersList","qualifiedName":"select_contact_view_model.SelectContactViewModel.getCurrentOrgUsersList","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get all users list of an current organization.","enclosedBy":{"name":"SelectContactViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md"}},{"name":"initialise","qualifiedName":"select_contact_view_model.SelectContactViewModel.initialise","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectContactViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md"}},{"name":"orgMembersList","qualifiedName":"select_contact_view_model.SelectContactViewModel.orgMembersList","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectContactViewModel","type":"class","href":"view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md"}},{"name":"select_language","qualifiedName":"select_language","href":"views_pre_auth_screens_select_language/views_pre_auth_screens_select_language-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SelectLanguage","qualifiedName":"select_language.SelectLanguage","href":"views_pre_auth_screens_select_language/SelectLanguage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget enables us to select a different language.\nThe default language is English. We can choose among the options to switch the language.\nThere is a text button at the right bottom of the screen which changes the language when tapped.\nThe user finally gets redirected to the previous screen.","enclosedBy":{"name":"select_language","type":"library","href":"views_pre_auth_screens_select_language/views_pre_auth_screens_select_language-library.md"}},{"name":"SelectLanguage","qualifiedName":"select_language.SelectLanguage.SelectLanguage","href":"views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectLanguage","type":"class","href":"views_pre_auth_screens_select_language/SelectLanguage-class.md"}},{"name":"createState","qualifiedName":"select_language.SelectLanguage.createState","href":"views_pre_auth_screens_select_language/SelectLanguage/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"SelectLanguage","type":"class","href":"views_pre_auth_screens_select_language/SelectLanguage-class.md"}},{"name":"select_organization","qualifiedName":"select_organization","href":"views_pre_auth_screens_select_organization/views_pre_auth_screens_select_organization-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SelectOrganization","qualifiedName":"select_organization.SelectOrganization","href":"views_pre_auth_screens_select_organization/SelectOrganization-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget lets the user select new organizations.","enclosedBy":{"name":"select_organization","type":"library","href":"views_pre_auth_screens_select_organization/views_pre_auth_screens_select_organization-library.md"}},{"name":"SelectOrganization","qualifiedName":"select_organization.SelectOrganization.SelectOrganization","href":"views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganization","type":"class","href":"views_pre_auth_screens_select_organization/SelectOrganization-class.md"}},{"name":"createState","qualifiedName":"select_organization.SelectOrganization.createState","href":"views_pre_auth_screens_select_organization/SelectOrganization/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"SelectOrganization","type":"class","href":"views_pre_auth_screens_select_organization/SelectOrganization-class.md"}},{"name":"selectedOrgId","qualifiedName":"select_organization.SelectOrganization.selectedOrgId","href":"views_pre_auth_screens_select_organization/SelectOrganization/selectedOrgId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Contains Integer value for selected org id.","enclosedBy":{"name":"SelectOrganization","type":"class","href":"views_pre_auth_screens_select_organization/SelectOrganization-class.md"}},{"name":"select_organization_view_model","qualifiedName":"select_organization_view_model","href":"view_model_pre_auth_view_models_select_organization_view_model/view_model_pre_auth_view_models_select_organization_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SelectOrganizationViewModel","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"SelectOrganizationViewModel class helps to interact with model to serve data\nand react to user's input in Select Organization View.","enclosedBy":{"name":"select_organization_view_model","type":"library","href":"view_model_pre_auth_view_models_select_organization_view_model/view_model_pre_auth_view_models_select_organization_view_model-library.md"}},{"name":"SelectOrganizationViewModel","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.SelectOrganizationViewModel","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/SelectOrganizationViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"allOrgController","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.allOrgController","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"controller","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.controller","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"fetchMoreHelper","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.fetchMoreHelper","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function fetch more option.","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"initialise","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.initialise","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"onTapContinue","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.onTapContinue","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"onTapJoin","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.onTapJoin","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function make user to join the selected organization.\nThe function uses joinOrgById graph QL query.","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"orgId","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.orgId","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"organizations","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.organizations","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"qrKey","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.qrKey","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"result","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.result","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"searchActive","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.searchActive","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"searchController","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.searchController","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"searchFocus","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.searchFocus","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"searching","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.searching","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"selectOrg","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.selectOrg","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function select the organization.","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"selectedOrganization","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.selectedOrganization","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"showSearchOrgList","qualifiedName":"select_organization_view_model.SelectOrganizationViewModel.showSearchOrgList","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SelectOrganizationViewModel","type":"class","href":"view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md"}},{"name":"set_url","qualifiedName":"set_url","href":"views_pre_auth_screens_set_url/views_pre_auth_screens_set_url-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SetUrl","qualifiedName":"set_url.SetUrl","href":"views_pre_auth_screens_set_url/SetUrl-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget lets a user sign in/up with the organization url.","enclosedBy":{"name":"set_url","type":"library","href":"views_pre_auth_screens_set_url/views_pre_auth_screens_set_url-library.md"}},{"name":"SetUrl","qualifiedName":"set_url.SetUrl.SetUrl","href":"views_pre_auth_screens_set_url/SetUrl/SetUrl.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SetUrl","type":"class","href":"views_pre_auth_screens_set_url/SetUrl-class.md"}},{"name":"createState","qualifiedName":"set_url.SetUrl.createState","href":"views_pre_auth_screens_set_url/SetUrl/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"SetUrl","type":"class","href":"views_pre_auth_screens_set_url/SetUrl-class.md"}},{"name":"uri","qualifiedName":"set_url.SetUrl.uri","href":"views_pre_auth_screens_set_url/SetUrl/uri.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Variable.","enclosedBy":{"name":"SetUrl","type":"class","href":"views_pre_auth_screens_set_url/SetUrl-class.md"}},{"name":"set_url_view_model","qualifiedName":"set_url_view_model","href":"view_model_pre_auth_view_models_set_url_view_model/view_model_pre_auth_view_models_set_url_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SetUrlViewModel","qualifiedName":"set_url_view_model.SetUrlViewModel","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"SetUrlViewModel class helps to interact with model to serve data.","enclosedBy":{"name":"set_url_view_model","type":"library","href":"view_model_pre_auth_view_models_set_url_view_model/view_model_pre_auth_view_models_set_url_view_model-library.md"}},{"name":"SetUrlViewModel","qualifiedName":"set_url_view_model.SetUrlViewModel.SetUrlViewModel","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/SetUrlViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"checkURLandNavigate","qualifiedName":"set_url_view_model.SetUrlViewModel.checkURLandNavigate","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function check the URL and navigate to the respective URL.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"checkURLandShowPopUp","qualifiedName":"set_url_view_model.SetUrlViewModel.checkURLandShowPopUp","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function check the URL and navigate to the respective URL.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"formKey","qualifiedName":"set_url_view_model.SetUrlViewModel.formKey","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"formKey.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"greeting","qualifiedName":"set_url_view_model.SetUrlViewModel.greeting","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"qrController.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"imageUrlKey","qualifiedName":"set_url_view_model.SetUrlViewModel.imageUrlKey","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"imageUrlKey.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"initialise","qualifiedName":"set_url_view_model.SetUrlViewModel.initialise","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function initialises the variables.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"orgId","qualifiedName":"set_url_view_model.SetUrlViewModel.orgId","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"organizationID.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"qrKey","qualifiedName":"set_url_view_model.SetUrlViewModel.qrKey","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"qrKey.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"result","qualifiedName":"set_url_view_model.SetUrlViewModel.result","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"qrText.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"scanQR","qualifiedName":"set_url_view_model.SetUrlViewModel.scanQR","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function create a widget which is used to scan the QR-code.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"url","qualifiedName":"set_url_view_model.SetUrlViewModel.url","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"url.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"urlFocus","qualifiedName":"set_url_view_model.SetUrlViewModel.urlFocus","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"urlFocus.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"urlKey","qualifiedName":"set_url_view_model.SetUrlViewModel.urlKey","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"urlKey.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"validate","qualifiedName":"set_url_view_model.SetUrlViewModel.validate","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"qrValidator.","enclosedBy":{"name":"SetUrlViewModel","type":"class","href":"view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md"}},{"name":"signup_details","qualifiedName":"signup_details","href":"views_pre_auth_screens_signup_details/views_pre_auth_screens_signup_details-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SignUpDetails","qualifiedName":"signup_details.SignUpDetails","href":"views_pre_auth_screens_signup_details/SignUpDetails-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget takes the user details for signup. The form includes first name, last name, email, password, and password confirmation inputs.","enclosedBy":{"name":"signup_details","type":"library","href":"views_pre_auth_screens_signup_details/views_pre_auth_screens_signup_details-library.md"}},{"name":"SignUpDetails","qualifiedName":"signup_details.SignUpDetails.SignUpDetails","href":"views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignUpDetails","type":"class","href":"views_pre_auth_screens_signup_details/SignUpDetails-class.md"}},{"name":"createState","qualifiedName":"signup_details.SignUpDetails.createState","href":"views_pre_auth_screens_signup_details/SignUpDetails/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"SignUpDetails","type":"class","href":"views_pre_auth_screens_signup_details/SignUpDetails-class.md"}},{"name":"selectedOrg","qualifiedName":"signup_details.SignUpDetails.selectedOrg","href":"views_pre_auth_screens_signup_details/SignUpDetails/selectedOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignUpDetails","type":"class","href":"views_pre_auth_screens_signup_details/SignUpDetails-class.md"}},{"name":"signup_details_view_model","qualifiedName":"signup_details_view_model","href":"view_model_pre_auth_view_models_signup_details_view_model/view_model_pre_auth_view_models_signup_details_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SignupDetailsViewModel","qualifiedName":"signup_details_view_model.SignupDetailsViewModel","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"SignupDetailsViewModel class helps to interact with model to serve data\nand react to user's input for Sign Up Details section.","enclosedBy":{"name":"signup_details_view_model","type":"library","href":"view_model_pre_auth_view_models_signup_details_view_model/view_model_pre_auth_view_models_signup_details_view_model-library.md"}},{"name":"SignupDetailsViewModel","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.SignupDetailsViewModel","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/SignupDetailsViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"confirmFocus","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.confirmFocus","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"confirmPassword","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.confirmPassword","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"email","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.email","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"firstName","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.firstName","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"formKey","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.formKey","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"greeting","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.greeting","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"hidePassword","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.hidePassword","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"initialise","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.initialise","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"lastName","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.lastName","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"password","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.password","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"selectedOrganization","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.selectedOrganization","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"signUp","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.signUp","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to sign up the user into the application by passing the data to database query.\nThe function uses gqlNonAuthMutation method provided by databaseFunctions services.","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"validate","qualifiedName":"signup_details_view_model.SignupDetailsViewModel.validate","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupDetailsViewModel","type":"class","href":"view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md"}},{"name":"signup_progress_indicator","qualifiedName":"signup_progress_indicator","href":"widgets_signup_progress_indicator/widgets_signup_progress_indicator-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SignupProgressIndicator","qualifiedName":"signup_progress_indicator.SignupProgressIndicator","href":"widgets_signup_progress_indicator/SignupProgressIndicator-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns a widget for showing the\nprogress indicator/flow while Signing Up/ Registration.","enclosedBy":{"name":"signup_progress_indicator","type":"library","href":"widgets_signup_progress_indicator/widgets_signup_progress_indicator-library.md"}},{"name":"SignupProgressIndicator","qualifiedName":"signup_progress_indicator.SignupProgressIndicator.SignupProgressIndicator","href":"widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupProgressIndicator","type":"class","href":"widgets_signup_progress_indicator/SignupProgressIndicator-class.md"}},{"name":"build","qualifiedName":"signup_progress_indicator.SignupProgressIndicator.build","href":"widgets_signup_progress_indicator/SignupProgressIndicator/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"SignupProgressIndicator","type":"class","href":"widgets_signup_progress_indicator/SignupProgressIndicator-class.md"}},{"name":"currentPageIndex","qualifiedName":"signup_progress_indicator.SignupProgressIndicator.currentPageIndex","href":"widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupProgressIndicator","type":"class","href":"widgets_signup_progress_indicator/SignupProgressIndicator-class.md"}},{"name":"progressLabel","qualifiedName":"signup_progress_indicator.SignupProgressIndicator.progressLabel","href":"widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SignupProgressIndicator","type":"class","href":"widgets_signup_progress_indicator/SignupProgressIndicator-class.md"}},{"name":"size_config","qualifiedName":"size_config","href":"services_size_config/services_size_config-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SizeConfig","qualifiedName":"size_config.SizeConfig","href":"services_size_config/SizeConfig-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"SizeConfig class is used to initialise the height and width of the media.","enclosedBy":{"name":"size_config","type":"library","href":"services_size_config/services_size_config-library.md"}},{"name":"SizeConfig","qualifiedName":"size_config.SizeConfig.SizeConfig","href":"services_size_config/SizeConfig/SizeConfig.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"blockSizeHorizontal","qualifiedName":"size_config.SizeConfig.blockSizeHorizontal","href":"services_size_config/SizeConfig/blockSizeHorizontal.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"blockSizeVertical","qualifiedName":"size_config.SizeConfig.blockSizeVertical","href":"services_size_config/SizeConfig/blockSizeVertical.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"init","qualifiedName":"size_config.SizeConfig.init","href":"services_size_config/SizeConfig/init.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"paddingTop","qualifiedName":"size_config.SizeConfig.paddingTop","href":"services_size_config/SizeConfig/paddingTop.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"safeBlockHorizontal","qualifiedName":"size_config.SizeConfig.safeBlockHorizontal","href":"services_size_config/SizeConfig/safeBlockHorizontal.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"safeBlockVertical","qualifiedName":"size_config.SizeConfig.safeBlockVertical","href":"services_size_config/SizeConfig/safeBlockVertical.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"screenHeight","qualifiedName":"size_config.SizeConfig.screenHeight","href":"services_size_config/SizeConfig/screenHeight.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"screenWidth","qualifiedName":"size_config.SizeConfig.screenWidth","href":"services_size_config/SizeConfig/screenWidth.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"test","qualifiedName":"size_config.SizeConfig.test","href":"services_size_config/SizeConfig/test.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SizeConfig","type":"class","href":"services_size_config/SizeConfig-class.md"}},{"name":"splash_screen","qualifiedName":"splash_screen","href":"splash_screen/splash_screen-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"SplashScreen","qualifiedName":"splash_screen.SplashScreen","href":"splash_screen/SplashScreen-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This widget return the SplashScreen. Splash Screen is the first screen that\nwe see when we run our application. It is also known as Launch Screen.","enclosedBy":{"name":"splash_screen","type":"library","href":"splash_screen/splash_screen-library.md"}},{"name":"SplashScreen","qualifiedName":"splash_screen.SplashScreen.SplashScreen","href":"splash_screen/SplashScreen/SplashScreen.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SplashScreen","type":"class","href":"splash_screen/SplashScreen-class.md"}},{"name":"createState","qualifiedName":"splash_screen.SplashScreen.createState","href":"splash_screen/SplashScreen/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"SplashScreen","type":"class","href":"splash_screen/SplashScreen-class.md"}},{"name":"mainScreenIndex","qualifiedName":"splash_screen.SplashScreen.mainScreenIndex","href":"splash_screen/SplashScreen/mainScreenIndex.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"SplashScreen","type":"class","href":"splash_screen/SplashScreen-class.md"}},{"name":"talawa_error_dialog","qualifiedName":"talawa_error_dialog","href":"widgets_talawa_error_dialog/widgets_talawa_error_dialog-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TalawaErrorDialog","qualifiedName":"talawa_error_dialog.TalawaErrorDialog","href":"widgets_talawa_error_dialog/TalawaErrorDialog-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"talawa_error_dialog","type":"library","href":"widgets_talawa_error_dialog/widgets_talawa_error_dialog-library.md"}},{"name":"TalawaErrorDialog","qualifiedName":"talawa_error_dialog.TalawaErrorDialog.TalawaErrorDialog","href":"widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaErrorDialog","type":"class","href":"widgets_talawa_error_dialog/TalawaErrorDialog-class.md"}},{"name":"build","qualifiedName":"talawa_error_dialog.TalawaErrorDialog.build","href":"widgets_talawa_error_dialog/TalawaErrorDialog/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"TalawaErrorDialog","type":"class","href":"widgets_talawa_error_dialog/TalawaErrorDialog-class.md"}},{"name":"errorMessage","qualifiedName":"talawa_error_dialog.TalawaErrorDialog.errorMessage","href":"widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaErrorDialog","type":"class","href":"widgets_talawa_error_dialog/TalawaErrorDialog-class.md"}},{"name":"messageType","qualifiedName":"talawa_error_dialog.TalawaErrorDialog.messageType","href":"widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaErrorDialog","type":"class","href":"widgets_talawa_error_dialog/TalawaErrorDialog-class.md"}},{"name":"talawa_error_snackbar","qualifiedName":"talawa_error_snackbar","href":"widgets_talawa_error_snackbar/widgets_talawa_error_snackbar-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TalawaErrorSnackBar","qualifiedName":"talawa_error_snackbar.TalawaErrorSnackBar","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"talawa_error_snackbar","type":"library","href":"widgets_talawa_error_snackbar/widgets_talawa_error_snackbar-library.md"}},{"name":"TalawaErrorSnackBar","qualifiedName":"talawa_error_snackbar.TalawaErrorSnackBar.TalawaErrorSnackBar","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaErrorSnackBar","type":"class","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md"}},{"name":"build","qualifiedName":"talawa_error_snackbar.TalawaErrorSnackBar.build","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"TalawaErrorSnackBar","type":"class","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md"}},{"name":"errorMessage","qualifiedName":"talawa_error_snackbar.TalawaErrorSnackBar.errorMessage","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaErrorSnackBar","type":"class","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md"}},{"name":"messageType","qualifiedName":"talawa_error_snackbar.TalawaErrorSnackBar.messageType","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaErrorSnackBar","type":"class","href":"widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md"}},{"name":"talawa_logo","qualifiedName":"talawa_logo","href":"custom_painters_talawa_logo/custom_painters_talawa_logo-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AppLogo","qualifiedName":"talawa_logo.AppLogo","href":"custom_painters_talawa_logo/AppLogo-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class draws the app logo using custom paint.\nCustomPaint is a widget from the Flutter SDK, which enables\nyou to use a canvas to draw different shapes.","enclosedBy":{"name":"talawa_logo","type":"library","href":"custom_painters_talawa_logo/custom_painters_talawa_logo-library.md"}},{"name":"AppLogo","qualifiedName":"talawa_logo.AppLogo.AppLogo","href":"custom_painters_talawa_logo/AppLogo/AppLogo.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppLogo","type":"class","href":"custom_painters_talawa_logo/AppLogo-class.md"}},{"name":"paint","qualifiedName":"talawa_logo.AppLogo.paint","href":"custom_painters_talawa_logo/AppLogo/paint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever the object needs to paint. The given Canvas has its\ncoordinate space configured such that the origin is at the top left of the\nbox. The area of the box is the size of the size argument.","enclosedBy":{"name":"AppLogo","type":"class","href":"custom_painters_talawa_logo/AppLogo-class.md"}},{"name":"shouldRepaint","qualifiedName":"talawa_logo.AppLogo.shouldRepaint","href":"custom_painters_talawa_logo/AppLogo/shouldRepaint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever a new instance of the custom painter delegate class is\nprovided to the RenderCustomPaint object, or any time that a new\nCustomPaint object is created with a new instance of the custom painter\ndelegate class (which amounts to the same thing, because the latter is\nimplemented in terms of the former).","enclosedBy":{"name":"AppLogo","type":"class","href":"custom_painters_talawa_logo/AppLogo-class.md"}},{"name":"talawa_plugin_provider","qualifiedName":"talawa_plugin_provider","href":"plugins_talawa_plugin_provider/plugins_talawa_plugin_provider-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TalawaPluginProvider","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"TalwaPluginProvider provides ability to implement features as plugins","enclosedBy":{"name":"talawa_plugin_provider","type":"library","href":"plugins_talawa_plugin_provider/plugins_talawa_plugin_provider-library.md"}},{"name":"TalawaPluginProvider","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider.TalawaPluginProvider","href":"plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TalawaPluginProvider","type":"class","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md"}},{"name":"build","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider.build","href":"plugins_talawa_plugin_provider/TalawaPluginProvider/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"build the Plugin combining local visibility property and serverVisible property","enclosedBy":{"name":"TalawaPluginProvider","type":"class","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md"}},{"name":"checkFromPluginList","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider.checkFromPluginList","href":"plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"return bool decides the final visibility of the verifying from database and current OrgId","enclosedBy":{"name":"TalawaPluginProvider","type":"class","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md"}},{"name":"child","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider.child","href":"plugins_talawa_plugin_provider/TalawaPluginProvider/child.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"child contains the widget for the plugin UI.","enclosedBy":{"name":"TalawaPluginProvider","type":"class","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md"}},{"name":"pluginName","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider.pluginName","href":"plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"name of plugin preferred with underscores(_) instead of spaces","enclosedBy":{"name":"TalawaPluginProvider","type":"class","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md"}},{"name":"visible","qualifiedName":"talawa_plugin_provider.TalawaPluginProvider.visible","href":"plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"visible is the property that decides visibility of the UI.","enclosedBy":{"name":"TalawaPluginProvider","type":"class","href":"plugins_talawa_plugin_provider/TalawaPluginProvider-class.md"}},{"name":"task_form","qualifiedName":"task_form","href":"widgets_task_form/widgets_task_form-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"DescriptionField","qualifiedName":"task_form.DescriptionField","href":"widgets_task_form/DescriptionField-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"task_form","type":"library","href":"widgets_task_form/widgets_task_form-library.md"}},{"name":"DescriptionField","qualifiedName":"task_form.DescriptionField.DescriptionField","href":"widgets_task_form/DescriptionField/DescriptionField.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"DescriptionField","type":"class","href":"widgets_task_form/DescriptionField-class.md"}},{"name":"build","qualifiedName":"task_form.DescriptionField.build","href":"widgets_task_form/DescriptionField/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"DescriptionField","type":"class","href":"widgets_task_form/DescriptionField-class.md"}},{"name":"TaskForm","qualifiedName":"task_form.TaskForm","href":"widgets_task_form/TaskForm-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"task_form","type":"library","href":"widgets_task_form/widgets_task_form-library.md"}},{"name":"TaskForm","qualifiedName":"task_form.TaskForm.TaskForm","href":"widgets_task_form/TaskForm/TaskForm.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskForm","type":"class","href":"widgets_task_form/TaskForm-class.md"}},{"name":"actionText","qualifiedName":"task_form.TaskForm.actionText","href":"widgets_task_form/TaskForm/actionText.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskForm","type":"class","href":"widgets_task_form/TaskForm-class.md"}},{"name":"createState","qualifiedName":"task_form.TaskForm.createState","href":"widgets_task_form/TaskForm/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"TaskForm","type":"class","href":"widgets_task_form/TaskForm-class.md"}},{"name":"onSave","qualifiedName":"task_form.TaskForm.onSave","href":"widgets_task_form/TaskForm/onSave.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskForm","type":"class","href":"widgets_task_form/TaskForm-class.md"}},{"name":"title","qualifiedName":"task_form.TaskForm.title","href":"widgets_task_form/TaskForm/title.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskForm","type":"class","href":"widgets_task_form/TaskForm-class.md"}},{"name":"TitleField","qualifiedName":"task_form.TitleField","href":"widgets_task_form/TitleField-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"task_form","type":"library","href":"widgets_task_form/widgets_task_form-library.md"}},{"name":"TitleField","qualifiedName":"task_form.TitleField.TitleField","href":"widgets_task_form/TitleField/TitleField.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TitleField","type":"class","href":"widgets_task_form/TitleField-class.md"}},{"name":"build","qualifiedName":"task_form.TitleField.build","href":"widgets_task_form/TitleField/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"TitleField","type":"class","href":"widgets_task_form/TitleField-class.md"}},{"name":"task_model","qualifiedName":"task_model","href":"models_task_task_model/models_task_task_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Task","qualifiedName":"task_model.Task","href":"models_task_task_model/Task-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"task_model","type":"library","href":"models_task_task_model/models_task_task_model-library.md"}},{"name":"Task","qualifiedName":"task_model.Task.Task","href":"models_task_task_model/Task/Task.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"createdAt","qualifiedName":"task_model.Task.createdAt","href":"models_task_task_model/Task/createdAt.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"creator","qualifiedName":"task_model.Task.creator","href":"models_task_task_model/Task/creator.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"deadline","qualifiedName":"task_model.Task.deadline","href":"models_task_task_model/Task/deadline.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"description","qualifiedName":"task_model.Task.description","href":"models_task_task_model/Task/description.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"event","qualifiedName":"task_model.Task.event","href":"models_task_task_model/Task/event.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"Task.fromJson","qualifiedName":"task_model.Task.fromJson","href":"models_task_task_model/Task/Task.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"/Creating a new Task instance from a map structure.","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"id","qualifiedName":"task_model.Task.id","href":"models_task_task_model/Task/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"title","qualifiedName":"task_model.Task.title","href":"models_task_task_model/Task/title.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Task","type":"class","href":"models_task_task_model/Task-class.md"}},{"name":"task_queries","qualifiedName":"task_queries","href":"utils_task_queries/utils_task_queries-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TaskQueries","qualifiedName":"task_queries.TaskQueries","href":"utils_task_queries/TaskQueries-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates queries for the tasks in the application.","enclosedBy":{"name":"task_queries","type":"library","href":"utils_task_queries/utils_task_queries-library.md"}},{"name":"TaskQueries","qualifiedName":"task_queries.TaskQueries.TaskQueries","href":"utils_task_queries/TaskQueries/TaskQueries.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskQueries","type":"class","href":"utils_task_queries/TaskQueries-class.md"}},{"name":"addTask","qualifiedName":"task_queries.TaskQueries.addTask","href":"utils_task_queries/TaskQueries/addTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskQueries","type":"class","href":"utils_task_queries/TaskQueries-class.md"}},{"name":"deleteTask","qualifiedName":"task_queries.TaskQueries.deleteTask","href":"utils_task_queries/TaskQueries/deleteTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskQueries","type":"class","href":"utils_task_queries/TaskQueries-class.md"}},{"name":"editTask","qualifiedName":"task_queries.TaskQueries.editTask","href":"utils_task_queries/TaskQueries/editTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskQueries","type":"class","href":"utils_task_queries/TaskQueries-class.md"}},{"name":"eventTasks","qualifiedName":"task_queries.TaskQueries.eventTasks","href":"utils_task_queries/TaskQueries/eventTasks.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskQueries","type":"class","href":"utils_task_queries/TaskQueries-class.md"}},{"name":"userTasks","qualifiedName":"task_queries.TaskQueries.userTasks","href":"utils_task_queries/TaskQueries/userTasks.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskQueries","type":"class","href":"utils_task_queries/TaskQueries-class.md"}},{"name":"task_schedule","qualifiedName":"task_schedule","href":"widgets_task_schedule/widgets_task_schedule-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TaskCard","qualifiedName":"task_schedule.TaskCard","href":"widgets_task_schedule/TaskCard-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"task_schedule","type":"library","href":"widgets_task_schedule/widgets_task_schedule-library.md"}},{"name":"TaskCard","qualifiedName":"task_schedule.TaskCard.TaskCard","href":"widgets_task_schedule/TaskCard/TaskCard.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskCard","type":"class","href":"widgets_task_schedule/TaskCard-class.md"}},{"name":"appointment","qualifiedName":"task_schedule.TaskCard.appointment","href":"widgets_task_schedule/TaskCard/appointment.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskCard","type":"class","href":"widgets_task_schedule/TaskCard-class.md"}},{"name":"build","qualifiedName":"task_schedule.TaskCard.build","href":"widgets_task_schedule/TaskCard/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"TaskCard","type":"class","href":"widgets_task_schedule/TaskCard-class.md"}},{"name":"showMoreOptions","qualifiedName":"task_schedule.TaskCard.showMoreOptions","href":"widgets_task_schedule/TaskCard/showMoreOptions.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskCard","type":"class","href":"widgets_task_schedule/TaskCard-class.md"}},{"name":"task","qualifiedName":"task_schedule.TaskCard.task","href":"widgets_task_schedule/TaskCard/task.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskCard","type":"class","href":"widgets_task_schedule/TaskCard-class.md"}},{"name":"TaskSchedule","qualifiedName":"task_schedule.TaskSchedule","href":"widgets_task_schedule/TaskSchedule-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"task_schedule","type":"library","href":"widgets_task_schedule/widgets_task_schedule-library.md"}},{"name":"TaskSchedule","qualifiedName":"task_schedule.TaskSchedule.TaskSchedule","href":"widgets_task_schedule/TaskSchedule/TaskSchedule.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskSchedule","type":"class","href":"widgets_task_schedule/TaskSchedule-class.md"}},{"name":"build","qualifiedName":"task_schedule.TaskSchedule.build","href":"widgets_task_schedule/TaskSchedule/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"TaskSchedule","type":"class","href":"widgets_task_schedule/TaskSchedule-class.md"}},{"name":"calendarTapped","qualifiedName":"task_schedule.TaskSchedule.calendarTapped","href":"widgets_task_schedule/TaskSchedule/calendarTapped.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskSchedule","type":"class","href":"widgets_task_schedule/TaskSchedule-class.md"}},{"name":"showMoreOptions","qualifiedName":"task_schedule.TaskSchedule.showMoreOptions","href":"widgets_task_schedule/TaskSchedule/showMoreOptions.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskSchedule","type":"class","href":"widgets_task_schedule/TaskSchedule-class.md"}},{"name":"tasks","qualifiedName":"task_schedule.TaskSchedule.tasks","href":"widgets_task_schedule/TaskSchedule/tasks.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskSchedule","type":"class","href":"widgets_task_schedule/TaskSchedule-class.md"}},{"name":"task_service","qualifiedName":"task_service","href":"services_task_service/services_task_service-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TaskService","qualifiedName":"task_service.TaskService","href":"services_task_service/TaskService-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"PostService class provides functions in the context of a Task.","enclosedBy":{"name":"task_service","type":"library","href":"services_task_service/services_task_service-library.md"}},{"name":"TaskService","qualifiedName":"task_service.TaskService.TaskService","href":"services_task_service/TaskService/TaskService.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"callbackNotifyListeners","qualifiedName":"task_service.TaskService.callbackNotifyListeners","href":"services_task_service/TaskService/callbackNotifyListeners.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"createTask","qualifiedName":"task_service.TaskService.createTask","href":"services_task_service/TaskService/createTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to create a new task for the event.","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"deleteTask","qualifiedName":"task_service.TaskService.deleteTask","href":"services_task_service/TaskService/deleteTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to delete a task.","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"editTask","qualifiedName":"task_service.TaskService.editTask","href":"services_task_service/TaskService/editTask.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to edit the task created by the user.","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"getTasksByUser","qualifiedName":"task_service.TaskService.getTasksByUser","href":"services_task_service/TaskService/getTasksByUser.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to fetch and return all tasks added by the current user.","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"getTasksForEvent","qualifiedName":"task_service.TaskService.getTasksForEvent","href":"services_task_service/TaskService/getTasksForEvent.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to get all the tasks for the event.","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"tasks","qualifiedName":"task_service.TaskService.tasks","href":"services_task_service/TaskService/tasks.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TaskService","type":"class","href":"services_task_service/TaskService-class.md"}},{"name":"telegram_logo","qualifiedName":"telegram_logo","href":"custom_painters_telegram_logo/custom_painters_telegram_logo-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TelegramLogo","qualifiedName":"telegram_logo.TelegramLogo","href":"custom_painters_telegram_logo/TelegramLogo-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class draws the telegram logo using custom paint.\nCustomPaint is a widget from the Flutter SDK, which enables\nyou to use a canvas to draw different shapes.","enclosedBy":{"name":"telegram_logo","type":"library","href":"custom_painters_telegram_logo/custom_painters_telegram_logo-library.md"}},{"name":"TelegramLogo","qualifiedName":"telegram_logo.TelegramLogo.TelegramLogo","href":"custom_painters_telegram_logo/TelegramLogo/TelegramLogo.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TelegramLogo","type":"class","href":"custom_painters_telegram_logo/TelegramLogo-class.md"}},{"name":"paint","qualifiedName":"telegram_logo.TelegramLogo.paint","href":"custom_painters_telegram_logo/TelegramLogo/paint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever the object needs to paint. The given Canvas has its\ncoordinate space configured such that the origin is at the top left of the\nbox. The area of the box is the size of the size argument.","enclosedBy":{"name":"TelegramLogo","type":"class","href":"custom_painters_telegram_logo/TelegramLogo-class.md"}},{"name":"shouldRepaint","qualifiedName":"telegram_logo.TelegramLogo.shouldRepaint","href":"custom_painters_telegram_logo/TelegramLogo/shouldRepaint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever a new instance of the custom painter delegate class is\nprovided to the RenderCustomPaint object, or any time that a new\nCustomPaint object is created with a new instance of the custom painter\ndelegate class (which amounts to the same thing, because the latter is\nimplemented in terms of the former).","enclosedBy":{"name":"TelegramLogo","type":"class","href":"custom_painters_telegram_logo/TelegramLogo-class.md"}},{"name":"theme_switch","qualifiedName":"theme_switch","href":"widgets_theme_switch/widgets_theme_switch-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"ChangeThemeTile","qualifiedName":"theme_switch.ChangeThemeTile","href":"widgets_theme_switch/ChangeThemeTile-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class enables theme switch.\nIt returns a ListTile which contains a Toggle button to switch between Dark and Light Themes.","enclosedBy":{"name":"theme_switch","type":"library","href":"widgets_theme_switch/widgets_theme_switch-library.md"}},{"name":"ChangeThemeTile","qualifiedName":"theme_switch.ChangeThemeTile.ChangeThemeTile","href":"widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"ChangeThemeTile","type":"class","href":"widgets_theme_switch/ChangeThemeTile-class.md"}},{"name":"build","qualifiedName":"theme_switch.ChangeThemeTile.build","href":"widgets_theme_switch/ChangeThemeTile/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"ChangeThemeTile","type":"class","href":"widgets_theme_switch/ChangeThemeTile-class.md"}},{"name":"theme_view_model","qualifiedName":"theme_view_model","href":"view_model_theme_view_model/view_model_theme_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"AppTheme","qualifiedName":"theme_view_model.AppTheme","href":"view_model_theme_view_model/AppTheme-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"AppTheme class is a type of View Model to serve data from modal to views in the context of App Themes.","enclosedBy":{"name":"theme_view_model","type":"library","href":"view_model_theme_view_model/view_model_theme_view_model-library.md"}},{"name":"AppTheme","qualifiedName":"theme_view_model.AppTheme.AppTheme","href":"view_model_theme_view_model/AppTheme/AppTheme.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"view_model_theme_view_model/AppTheme-class.md"}},{"name":"initialize","qualifiedName":"theme_view_model.AppTheme.initialize","href":"view_model_theme_view_model/AppTheme/initialize.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"view_model_theme_view_model/AppTheme-class.md"}},{"name":"isdarkTheme","qualifiedName":"theme_view_model.AppTheme.isdarkTheme","href":"view_model_theme_view_model/AppTheme/isdarkTheme.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"view_model_theme_view_model/AppTheme-class.md"}},{"name":"key","qualifiedName":"theme_view_model.AppTheme.key","href":"view_model_theme_view_model/AppTheme/key.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"AppTheme","type":"class","href":"view_model_theme_view_model/AppTheme-class.md"}},{"name":"switchTheme","qualifiedName":"theme_view_model.AppTheme.switchTheme","href":"view_model_theme_view_model/AppTheme/switchTheme.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function switches the app theme.","enclosedBy":{"name":"AppTheme","type":"class","href":"view_model_theme_view_model/AppTheme-class.md"}},{"name":"timeout","qualifiedName":"timeout","href":"constants_timeout/constants_timeout-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"TimeOuts","qualifiedName":"timeout.TimeOuts","href":"constants_timeout/TimeOuts-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"Class to define constant timeout to bring consistency in the code.","enclosedBy":{"name":"timeout","type":"library","href":"constants_timeout/constants_timeout-library.md"}},{"name":"TimeOuts","qualifiedName":"timeout.TimeOuts.TimeOuts","href":"constants_timeout/TimeOuts/TimeOuts.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"TimeOuts","type":"class","href":"constants_timeout/TimeOuts-class.md"}},{"name":"large","qualifiedName":"timeout.TimeOuts.large","href":"constants_timeout/TimeOuts/large-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"For large timeout, used for large data fetch.","enclosedBy":{"name":"TimeOuts","type":"class","href":"constants_timeout/TimeOuts-class.md"}},{"name":"mediums","qualifiedName":"timeout.TimeOuts.mediums","href":"constants_timeout/TimeOuts/mediums-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"For medium timeout, used for medium data fetch.","enclosedBy":{"name":"TimeOuts","type":"class","href":"constants_timeout/TimeOuts-class.md"}},{"name":"small","qualifiedName":"timeout.TimeOuts.small","href":"constants_timeout/TimeOuts/small-constant.md","type":"constant","overriddenDepth":0,"packageName":"talawa","desc":"For small timeout, used for small data fetch.","enclosedBy":{"name":"TimeOuts","type":"class","href":"constants_timeout/TimeOuts-class.md"}},{"name":"user_config","qualifiedName":"user_config","href":"services_user_config/services_user_config-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"UserConfig","qualifiedName":"user_config.UserConfig","href":"services_user_config/UserConfig-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"UserConfig class provides different services in the context of the User.","enclosedBy":{"name":"user_config","type":"library","href":"services_user_config/services_user_config-library.md"}},{"name":"UserConfig","qualifiedName":"user_config.UserConfig.UserConfig","href":"services_user_config/UserConfig/UserConfig.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"currentOrg","qualifiedName":"user_config.UserConfig.currentOrg","href":"services_user_config/UserConfig/currentOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"currentOrgInfoController","qualifiedName":"user_config.UserConfig.currentOrgInfoController","href":"services_user_config/UserConfig/currentOrgInfoController.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"currentOrgInfoStream","qualifiedName":"user_config.UserConfig.currentOrgInfoStream","href":"services_user_config/UserConfig/currentOrgInfoStream.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"currentOrgName","qualifiedName":"user_config.UserConfig.currentOrgName","href":"services_user_config/UserConfig/currentOrgName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"currentUser","qualifiedName":"user_config.UserConfig.currentUser","href":"services_user_config/UserConfig/currentUser.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"initialiseStream","qualifiedName":"user_config.UserConfig.initialiseStream","href":"services_user_config/UserConfig/initialiseStream.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"saveCurrentOrgInHive","qualifiedName":"user_config.UserConfig.saveCurrentOrgInHive","href":"services_user_config/UserConfig/saveCurrentOrgInHive.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"saveUserInHive","qualifiedName":"user_config.UserConfig.saveUserInHive","href":"services_user_config/UserConfig/saveUserInHive.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"updateAccessToken","qualifiedName":"user_config.UserConfig.updateAccessToken","href":"services_user_config/UserConfig/updateAccessToken.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to updated the access token of the user.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"updateUser","qualifiedName":"user_config.UserConfig.updateUser","href":"services_user_config/UserConfig/updateUser.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to update the user details.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"updateUserAdminOrg","qualifiedName":"user_config.UserConfig.updateUserAdminOrg","href":"services_user_config/UserConfig/updateUserAdminOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to update the organization admin.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"updateUserCreatedOrg","qualifiedName":"user_config.UserConfig.updateUserCreatedOrg","href":"services_user_config/UserConfig/updateUserCreatedOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to update the user created organization.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"updateUserJoinedOrg","qualifiedName":"user_config.UserConfig.updateUserJoinedOrg","href":"services_user_config/UserConfig/updateUserJoinedOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to update the user joined organization.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"updateUserMemberRequestOrg","qualifiedName":"user_config.UserConfig.updateUserMemberRequestOrg","href":"services_user_config/UserConfig/updateUserMemberRequestOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to update the user request to join the organization.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"userLoggedIn","qualifiedName":"user_config.UserConfig.userLoggedIn","href":"services_user_config/UserConfig/userLoggedIn.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function is used to log in the user.","enclosedBy":{"name":"UserConfig","type":"class","href":"services_user_config/UserConfig-class.md"}},{"name":"user_info","qualifiedName":"user_info","href":"models_user_user_info/models_user_user_info-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"User","qualifiedName":"user_info.User","href":"models_user_user_info/User-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates a User model and returns a user instance.","enclosedBy":{"name":"user_info","type":"library","href":"models_user_user_info/models_user_user_info-library.md"}},{"name":"User","qualifiedName":"user_info.User.User","href":"models_user_user_info/User/User.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"adminFor","qualifiedName":"user_info.User.adminFor","href":"models_user_user_info/User/adminFor.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"authToken","qualifiedName":"user_info.User.authToken","href":"models_user_user_info/User/authToken.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"createdOrganizations","qualifiedName":"user_info.User.createdOrganizations","href":"models_user_user_info/User/createdOrganizations.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"email","qualifiedName":"user_info.User.email","href":"models_user_user_info/User/email.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"firstName","qualifiedName":"user_info.User.firstName","href":"models_user_user_info/User/firstName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"User.fromJson","qualifiedName":"user_info.User.fromJson","href":"models_user_user_info/User/User.fromJson.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"id","qualifiedName":"user_info.User.id","href":"models_user_user_info/User/id.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"image","qualifiedName":"user_info.User.image","href":"models_user_user_info/User/image.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"joinedOrganizations","qualifiedName":"user_info.User.joinedOrganizations","href":"models_user_user_info/User/joinedOrganizations.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"lastName","qualifiedName":"user_info.User.lastName","href":"models_user_user_info/User/lastName.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"membershipRequests","qualifiedName":"user_info.User.membershipRequests","href":"models_user_user_info/User/membershipRequests.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"print","qualifiedName":"user_info.User.print","href":"models_user_user_info/User/print.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"refreshToken","qualifiedName":"user_info.User.refreshToken","href":"models_user_user_info/User/refreshToken.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"update","qualifiedName":"user_info.User.update","href":"models_user_user_info/User/update.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"updateAdminFor","qualifiedName":"user_info.User.updateAdminFor","href":"models_user_user_info/User/updateAdminFor.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"updateCreatedOrg","qualifiedName":"user_info.User.updateCreatedOrg","href":"models_user_user_info/User/updateCreatedOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"updateJoinedOrg","qualifiedName":"user_info.User.updateJoinedOrg","href":"models_user_user_info/User/updateJoinedOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"updateMemberRequestOrg","qualifiedName":"user_info.User.updateMemberRequestOrg","href":"models_user_user_info/User/updateMemberRequestOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"User","type":"class","href":"models_user_user_info/User-class.md"}},{"name":"UserAdapter","qualifiedName":"user_info.UserAdapter","href":"models_user_user_info/UserAdapter-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"user_info","type":"library","href":"models_user_user_info/models_user_user_info-library.md"}},{"name":"operator ==","qualifiedName":"user_info.UserAdapter.==","href":"models_user_user_info/UserAdapter/operator_equals.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"The equality operator.","enclosedBy":{"name":"UserAdapter","type":"class","href":"models_user_user_info/UserAdapter-class.md"}},{"name":"UserAdapter","qualifiedName":"user_info.UserAdapter.UserAdapter","href":"models_user_user_info/UserAdapter/UserAdapter.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserAdapter","type":"class","href":"models_user_user_info/UserAdapter-class.md"}},{"name":"hashCode","qualifiedName":"user_info.UserAdapter.hashCode","href":"models_user_user_info/UserAdapter/hashCode.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"The hash code for this object.","enclosedBy":{"name":"UserAdapter","type":"class","href":"models_user_user_info/UserAdapter-class.md"}},{"name":"read","qualifiedName":"user_info.UserAdapter.read","href":"models_user_user_info/UserAdapter/read.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Is called when a value has to be decoded.","enclosedBy":{"name":"UserAdapter","type":"class","href":"models_user_user_info/UserAdapter-class.md"}},{"name":"typeId","qualifiedName":"user_info.UserAdapter.typeId","href":"models_user_user_info/UserAdapter/typeId.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"Called for type registration","enclosedBy":{"name":"UserAdapter","type":"class","href":"models_user_user_info/UserAdapter-class.md"}},{"name":"write","qualifiedName":"user_info.UserAdapter.write","href":"models_user_user_info/UserAdapter/write.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Is called when a value has to be encoded.","enclosedBy":{"name":"UserAdapter","type":"class","href":"models_user_user_info/UserAdapter-class.md"}},{"name":"user_tasks_page","qualifiedName":"user_tasks_page","href":"views_after_auth_screens_tasks_user_tasks_page/views_after_auth_screens_tasks_user_tasks_page-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"UserTasksPage","qualifiedName":"user_tasks_page.UserTasksPage","href":"views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"UserTasksPage returns a widget for page of User Tasks.","enclosedBy":{"name":"user_tasks_page","type":"library","href":"views_after_auth_screens_tasks_user_tasks_page/views_after_auth_screens_tasks_user_tasks_page-library.md"}},{"name":"UserTasksPage","qualifiedName":"user_tasks_page.UserTasksPage.UserTasksPage","href":"views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"UserTasksPage","type":"class","href":"views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md"}},{"name":"build","qualifiedName":"user_tasks_page.UserTasksPage.build","href":"views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"UserTasksPage","type":"class","href":"views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md"}},{"name":"validators","qualifiedName":"validators","href":"utils_validators/utils_validators-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"Validator","qualifiedName":"validators.Validator","href":"utils_validators/Validator-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creats various validator methods for the application.\nThey are used to validate information given by the users.","enclosedBy":{"name":"validators","type":"library","href":"utils_validators/utils_validators-library.md"}},{"name":"Validator","qualifiedName":"validators.Validator.Validator","href":"utils_validators/Validator/Validator.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validateEmail","qualifiedName":"validators.Validator.validateEmail","href":"utils_validators/Validator/validateEmail.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validateEventForm","qualifiedName":"validators.Validator.validateEventForm","href":"utils_validators/Validator/validateEventForm.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validateFirstName","qualifiedName":"validators.Validator.validateFirstName","href":"utils_validators/Validator/validateFirstName.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validateLastName","qualifiedName":"validators.Validator.validateLastName","href":"utils_validators/Validator/validateLastName.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validatePassword","qualifiedName":"validators.Validator.validatePassword","href":"utils_validators/Validator/validatePassword.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validatePasswordConfirm","qualifiedName":"validators.Validator.validatePasswordConfirm","href":"utils_validators/Validator/validatePasswordConfirm.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validateURL","qualifiedName":"validators.Validator.validateURL","href":"utils_validators/Validator/validateURL.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"validateUrlExistence","qualifiedName":"validators.Validator.validateUrlExistence","href":"utils_validators/Validator/validateUrlExistence.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"Validator","type":"class","href":"utils_validators/Validator-class.md"}},{"name":"video_widget","qualifiedName":"video_widget","href":"widgets_video_widget/widgets_video_widget-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"VideoWidget","qualifiedName":"video_widget.VideoWidget","href":"widgets_video_widget/VideoWidget-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class creates a video widget.","enclosedBy":{"name":"video_widget","type":"library","href":"widgets_video_widget/widgets_video_widget-library.md"}},{"name":"VideoWidget","qualifiedName":"video_widget.VideoWidget.VideoWidget","href":"widgets_video_widget/VideoWidget/VideoWidget.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"VideoWidget","type":"class","href":"widgets_video_widget/VideoWidget-class.md"}},{"name":"createState","qualifiedName":"video_widget.VideoWidget.createState","href":"widgets_video_widget/VideoWidget/createState.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Creates the mutable state for this widget at a given location in the tree.","enclosedBy":{"name":"VideoWidget","type":"class","href":"widgets_video_widget/VideoWidget-class.md"}},{"name":"play","qualifiedName":"video_widget.VideoWidget.play","href":"widgets_video_widget/VideoWidget/play.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"VideoWidget","type":"class","href":"widgets_video_widget/VideoWidget-class.md"}},{"name":"url","qualifiedName":"video_widget.VideoWidget.url","href":"widgets_video_widget/VideoWidget/url.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"VideoWidget","type":"class","href":"widgets_video_widget/VideoWidget-class.md"}},{"name":"waiting_to_join_private_org","qualifiedName":"waiting_to_join_private_org","href":"views_pre_auth_screens_waiting_to_join_private_org/views_pre_auth_screens_waiting_to_join_private_org-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"WaitingPage","qualifiedName":"waiting_to_join_private_org.WaitingPage","href":"views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class returns a widget which shows the request sent by the user to join a private organization.","enclosedBy":{"name":"waiting_to_join_private_org","type":"library","href":"views_pre_auth_screens_waiting_to_join_private_org/views_pre_auth_screens_waiting_to_join_private_org-library.md"}},{"name":"WaitingPage","qualifiedName":"waiting_to_join_private_org.WaitingPage.WaitingPage","href":"views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingPage","type":"class","href":"views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md"}},{"name":"build","qualifiedName":"waiting_to_join_private_org.WaitingPage.build","href":"views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Describes the part of the user interface represented by this widget.","enclosedBy":{"name":"WaitingPage","type":"class","href":"views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md"}},{"name":"waiting_view_model","qualifiedName":"waiting_view_model","href":"view_model_pre_auth_view_models_waiting_view_model/view_model_pre_auth_view_models_waiting_view_model-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"WaitingViewModel","qualifiedName":"waiting_view_model.WaitingViewModel","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"WaitingViewModel class helps to interact with model to serve data\nand react to user's input for Waiting section.","enclosedBy":{"name":"waiting_view_model","type":"library","href":"view_model_pre_auth_view_models_waiting_view_model/view_model_pre_auth_view_models_waiting_view_model-library.md"}},{"name":"WaitingViewModel","qualifiedName":"waiting_view_model.WaitingViewModel.WaitingViewModel","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/WaitingViewModel.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"currentUser","qualifiedName":"waiting_view_model.WaitingViewModel.currentUser","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"greeting","qualifiedName":"waiting_view_model.WaitingViewModel.greeting","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"initialise","qualifiedName":"waiting_view_model.WaitingViewModel.initialise","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"joinOrg","qualifiedName":"waiting_view_model.WaitingViewModel.joinOrg","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"logout","qualifiedName":"waiting_view_model.WaitingViewModel.logout","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md","type":"method","overriddenDepth":0,"packageName":"talawa","desc":"This function ends the session for the user or logout the user from the application.","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"pendingRequestOrg","qualifiedName":"waiting_view_model.WaitingViewModel.pendingRequestOrg","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md","type":"property","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WaitingViewModel","type":"class","href":"view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md"}},{"name":"whatsapp_logo","qualifiedName":"whatsapp_logo","href":"custom_painters_whatsapp_logo/custom_painters_whatsapp_logo-library.md","type":"library","overriddenDepth":0,"packageName":"talawa","desc":""},{"name":"WhatsappLogo","qualifiedName":"whatsapp_logo.WhatsappLogo","href":"custom_painters_whatsapp_logo/WhatsappLogo-class.md","type":"class","overriddenDepth":0,"packageName":"talawa","desc":"This class draws the whatsapp logo using custom paint.\nCustomPaint is a widget from the Flutter SDK, which enables\nyou to use a canvas to draw different shapes.","enclosedBy":{"name":"whatsapp_logo","type":"library","href":"custom_painters_whatsapp_logo/custom_painters_whatsapp_logo-library.md"}},{"name":"WhatsappLogo","qualifiedName":"whatsapp_logo.WhatsappLogo.WhatsappLogo","href":"custom_painters_whatsapp_logo/WhatsappLogo/WhatsappLogo.md","type":"constructor","overriddenDepth":0,"packageName":"talawa","desc":"","enclosedBy":{"name":"WhatsappLogo","type":"class","href":"custom_painters_whatsapp_logo/WhatsappLogo-class.md"}},{"name":"paint","qualifiedName":"whatsapp_logo.WhatsappLogo.paint","href":"custom_painters_whatsapp_logo/WhatsappLogo/paint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever the object needs to paint. The given Canvas has its\ncoordinate space configured such that the origin is at the top left of the\nbox. The area of the box is the size of the size argument.","enclosedBy":{"name":"WhatsappLogo","type":"class","href":"custom_painters_whatsapp_logo/WhatsappLogo-class.md"}},{"name":"shouldRepaint","qualifiedName":"whatsapp_logo.WhatsappLogo.shouldRepaint","href":"custom_painters_whatsapp_logo/WhatsappLogo/shouldRepaint.md","type":"method","overriddenDepth":1,"packageName":"talawa","desc":"Called whenever a new instance of the custom painter delegate class is\nprovided to the RenderCustomPaint object, or any time that a new\nCustomPaint object is created with a new instance of the custom painter\ndelegate class (which amounts to the same thing, because the latter is\nimplemented in terms of the former).","enclosedBy":{"name":"WhatsappLogo","type":"class","href":"custom_painters_whatsapp_logo/WhatsappLogo-class.md"}}] diff --git a/talawa-mobile-docs/index.md b/talawa-mobile-docs/index.md new file mode 100644 index 0000000000..a21691b89a --- /dev/null +++ b/talawa-mobile-docs/index.md @@ -0,0 +1,654 @@ + + + +# 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. +
+ + +## Libraries + +##### [access_request_screen](views_after_auth_screens_join_org_after_auth_access_request_screen/views_after_auth_screens_join_org_after_auth_access_request_screen-library.md) + + + +##### [access_request_view_model](view_model_access_request_view_model/view_model_access_request_view_model-library.md) + + + +##### [add_members_bottom_sheet](widgets_add_members_bottom_sheet/widgets_add_members_bottom_sheet-library.md) + + + +##### [add_post_page](views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md) + + + +##### [add_post_view_model](view_model_after_auth_view_models_add_post_view_models_add_post_view_model/view_model_after_auth_view_models_add_post_view_models_add_post_view_model-library.md) + + + +##### [app_localization](utils_app_localization/utils_app_localization-library.md) + + + +##### [app_settings_page](views_after_auth_screens_app_settings_app_settings_page/views_after_auth_screens_app_settings_app_settings_page-library.md) + + + +##### [apptheme](apptheme/apptheme-library.md) + + + +##### [base_view](views_base_view/views_base_view-library.md) + + + +##### [base_view_model](view_model_base_view_model/view_model_base_view_model-library.md) + + + +##### [change_password](views_pre_auth_screens_change_password/views_pre_auth_screens_change_password-library.md) + + + +##### [chat_input_field](views_after_auth_screens_chat_widgets_chat_input_field/views_after_auth_screens_chat_widgets_chat_input_field-library.md) + + + +##### [chat_list_screen](views_after_auth_screens_chat_chat_list_screen/views_after_auth_screens_chat_chat_list_screen-library.md) + + + +##### [chat_list_tile_data_model](models_chats_chat_list_tile_data_model/models_chats_chat_list_tile_data_model-library.md) + + + +##### [chat_message](models_chats_chat_message/models_chats_chat_message-library.md) + + + +##### [chat_message_bubble](views_after_auth_screens_chat_widgets_chat_message_bubble/views_after_auth_screens_chat_widgets_chat_message_bubble-library.md) + + + +##### [chat_message_screen](views_after_auth_screens_chat_chat_message_screen/views_after_auth_screens_chat_chat_message_screen-library.md) + + + +##### [chat_queries](utils_chat_queries/utils_chat_queries-library.md) + + + +##### [chat_service](services_chat_service/services_chat_service-library.md) + + + +##### [chat_user](models_chats_chat_user/models_chats_chat_user-library.md) + + + +##### [comment_model](models_comment_comment_model/models_comment_comment_model-library.md) + + + +##### [comment_queries](utils_comment_queries/utils_comment_queries-library.md) + + + +##### [comment_service](services_comment_service/services_comment_service-library.md) + + + +##### [comments_view_model](view_model_widgets_view_models_comments_view_model/view_model_widgets_view_models_comments_view_model-library.md) + + + +##### [constants](constants_constants/constants_constants-library.md) + + + +##### [create_event_form](views_after_auth_screens_events_create_event_form/views_after_auth_screens_events_create_event_form-library.md) + + + +##### [create_event_page](views_after_auth_screens_events_create_event_page/views_after_auth_screens_events_create_event_page-library.md) + + + +##### [create_event_view_model](view_model_after_auth_view_models_event_view_models_create_event_view_model/view_model_after_auth_view_models_event_view_models_create_event_view_model-library.md) + + + +##### [create_task_page](views_after_auth_screens_tasks_create_task_page/views_after_auth_screens_tasks_create_task_page-library.md) + + + +##### [create_task_view_model](view_model_after_auth_view_models_task_view_models_create_task_view_model/view_model_after_auth_view_models_task_view_models_create_task_view_model-library.md) + + + +##### [custom_alert_dialog](widgets_custom_alert_dialog/widgets_custom_alert_dialog-library.md) + + + +##### [custom_avatar](widgets_custom_avatar/widgets_custom_avatar-library.md) + + + +##### [custom_drawer](widgets_custom_drawer/widgets_custom_drawer-library.md) + + + +##### [custom_drawer_view_model](view_model_widgets_view_models_custom_drawer_view_model/view_model_widgets_view_models_custom_drawer_view_model-library.md) + + + +##### [custom_list_tile](widgets_custom_list_tile/widgets_custom_list_tile-library.md) + + + +##### [custom_progress_dialog](widgets_custom_progress_dialog/widgets_custom_progress_dialog-library.md) + + + +##### [custom_theme](constants_custom_theme/constants_custom_theme-library.md) + + + +##### [database_mutation_functions](services_database_mutation_functions/services_database_mutation_functions-library.md) + + + +##### [date_time_picker](widgets_date_time_picker/widgets_date_time_picker-library.md) + + + +##### [direct_chat_demo_data](demo_server_data_direct_chat_demo_data/demo_server_data_direct_chat_demo_data-library.md) + + + +##### [direct_chat_view_model](view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model-library.md) + + + +##### [direct_chats](views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md) + + + +##### [edit_event_page](views_after_auth_screens_events_edit_event_page/views_after_auth_screens_events_edit_event_page-library.md) + + + +##### [edit_event_view_model](view_model_after_auth_view_models_event_view_models_edit_event_view_model/view_model_after_auth_view_models_event_view_models_edit_event_view_model-library.md) + + + +##### [edit_events_form](views_after_auth_screens_events_edit_events_form/views_after_auth_screens_events_edit_events_form-library.md) + + + +##### [edit_profile_page](views_after_auth_screens_profile_edit_profile_page/views_after_auth_screens_profile_edit_profile_page-library.md) + + + +##### [edit_profile_view_model](view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model-library.md) + + + +##### [edit_task_page](views_after_auth_screens_tasks_edit_task_page/views_after_auth_screens_tasks_edit_task_page-library.md) + + + +##### [enums](enums_enums/enums_enums-library.md) + + + +##### [event_calendar](views_after_auth_screens_events_event_calendar/views_after_auth_screens_events_event_calendar-library.md) + + + +##### [event_card](widgets_event_card/widgets_event_card-library.md) + + + +##### [event_card_view_model](view_model_widgets_view_models_event_card_view_model/view_model_widgets_view_models_event_card_view_model-library.md) + + + +##### [event_chats](views_after_auth_screens_chat_event_chats/views_after_auth_screens_chat_event_chats-library.md) + + + +##### [event_date_time_tile](widgets_event_date_time_tile/widgets_event_date_time_tile-library.md) + + + +##### [event_info_body](views_after_auth_screens_events_event_info_body/views_after_auth_screens_events_event_info_body-library.md) + + + +##### [event_info_page](views_after_auth_screens_events_event_info_page/views_after_auth_screens_events_event_info_page-library.md) + + + +##### [event_info_view_model](view_model_after_auth_view_models_event_view_models_event_info_view_model/view_model_after_auth_view_models_event_view_models_event_info_view_model-library.md) + + + +##### [event_model](models_events_event_model/models_events_event_model-library.md) + + + +##### [event_queries](utils_event_queries/utils_event_queries-library.md) + + + +##### [event_search_delegate](widgets_event_search_delegate/widgets_event_search_delegate-library.md) + + + +##### [event_service](services_event_service/services_event_service-library.md) + + + +##### [event_tasks_page](views_after_auth_screens_tasks_event_tasks_page/views_after_auth_screens_tasks_event_tasks_page-library.md) + + + +##### [events_demo_data](demo_server_data_events_demo_data/demo_server_data_events_demo_data-library.md) + + + +##### [explore_event_dialogue](views_after_auth_screens_events_explore_event_dialogue/views_after_auth_screens_events_explore_event_dialogue-library.md) + + + +##### [explore_events](views_after_auth_screens_events_explore_events/views_after_auth_screens_events_explore_events-library.md) + + + +##### [explore_events_view_model](view_model_after_auth_view_models_event_view_models_explore_events_view_model/view_model_after_auth_view_models_event_view_models_explore_events_view_model-library.md) + + + +##### [explore_tasks_view_model](view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model-library.md) + + + +##### [fetch_plugin_list](plugins_fetch_plugin_list/plugins_fetch_plugin_list-library.md) + + + +##### [firebase_options](firebase_options/firebase_options-library.md) + + + +##### [from_palisadoes](widgets_from_palisadoes/widgets_from_palisadoes-library.md) + + + +##### [generated_plugin_registrant](generated_plugin_registrant/generated_plugin_registrant-library.md) + + + +##### [graphql_config](services_graphql_config/services_graphql_config-library.md) + + + +##### [individual_post](views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md) + + + +##### [invite_child](widgets_invite_child/widgets_invite_child-library.md) + + + +##### [join_organisation_after_auth](views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth-library.md) + + + +##### [lang_switch](widgets_lang_switch/widgets_lang_switch-library.md) + + + +##### [lang_view_model](view_model_lang_view_model/view_model_lang_view_model-library.md) + + + +##### [language_icon](custom_painters_language_icon/custom_painters_language_icon-library.md) + + + +##### [language_model](models_language_language_model/models_language_language_model-library.md) + + + +##### [like_button_view_model](view_model_widgets_view_models_like_button_view_model/view_model_widgets_view_models_like_button_view_model-library.md) + + + +##### [locator](locator/locator-library.md) + + + +##### [login](views_pre_auth_screens_login/views_pre_auth_screens_login-library.md) + + + +##### [login_view_model](view_model_pre_auth_view_models_login_view_model/view_model_pre_auth_view_models_login_view_model-library.md) + + + +##### [main](main/main-library.md) + + + +##### [main_screen](views_main_screen/views_main_screen-library.md) + + + +##### [main_screen_view_model](view_model_main_screen_view_model/view_model_main_screen_view_model-library.md) + + + +##### [mainscreen_navigation_args](models_mainscreen_navigation_args/models_mainscreen_navigation_args-library.md) + + + +##### [map_screen](views_after_auth_screens_venue_map_screen/views_after_auth_screens_venue_map_screen-library.md) + + + +##### [member_name_tile](widgets_member_name_tile/widgets_member_name_tile-library.md) + + + +##### [multi_media_pick_service](services_third_party_service_multi_media_pick_service/services_third_party_service_multi_media_pick_service-library.md) + + + +##### [navigation_service](services_navigation_service/services_navigation_service-library.md) + + + +##### [options](models_options_options/models_options_options-library.md) + + + +##### [org_info](models_organization_org_info/models_organization_org_info-library.md) + + + +##### [org_service](services_org_service/services_org_service-library.md) + + + +##### [organization_feed](views_after_auth_screens_feed_organization_feed/views_after_auth_screens_feed_organization_feed-library.md) + + + +##### [organization_feed_view_model](view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model-library.md) + + + +##### [organization_list](widgets_organization_list/widgets_organization_list-library.md) + + + +##### [organization_search_list](widgets_organization_search_list/widgets_organization_search_list-library.md) + + + +##### [pinned_carousel_widget](widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md) + + + +##### [pinned_post_demo_data](demo_server_data_pinned_post_demo_data/demo_server_data_pinned_post_demo_data-library.md) + + + +##### [pinned_post_page](views_after_auth_screens_feed_pinned_post_page/views_after_auth_screens_feed_pinned_post_page-library.md) + + + +##### [post_demo_data](demo_server_data_post_demo_data/demo_server_data_post_demo_data-library.md) + + + +##### [post_detailed_page](widgets_post_detailed_page/widgets_post_detailed_page-library.md) + + + +##### [post_list_widget](widgets_post_list_widget/widgets_post_list_widget-library.md) + + + +##### [post_model](models_post_post_model/models_post_post_model-library.md) + + + +##### [post_queries](utils_post_queries/utils_post_queries-library.md) + + + +##### [post_service](services_post_service/services_post_service-library.md) + + + +##### [post_widget](widgets_post_widget/widgets_post_widget-library.md) + + + +##### [profile_page](views_after_auth_screens_profile_profile_page/views_after_auth_screens_profile_profile_page-library.md) + + + +##### [profile_page_view_model](view_model_after_auth_view_models_profile_view_models_profile_page_view_model/view_model_after_auth_view_models_profile_view_models_profile_page_view_model-library.md) + + + +##### [progress_dialog_view_model](view_model_widgets_view_models_progress_dialog_view_model/view_model_widgets_view_models_progress_dialog_view_model-library.md) + + + +##### [queries](utils_queries/utils_queries-library.md) + + + +##### [quick_actions](constants_quick_actions/constants_quick_actions-library.md) + + + +##### [raised_round_edge_button](widgets_raised_round_edge_button/widgets_raised_round_edge_button-library.md) + + + +##### [recover](views_pre_auth_screens_recover/views_pre_auth_screens_recover-library.md) + + + +##### [rich_text](widgets_rich_text/widgets_rich_text-library.md) + + + +##### [router](router/router-library.md) + + + +##### [routing_constants](constants_routing_constants/constants_routing_constants-library.md) + + + +##### [select_contact](views_after_auth_screens_chat_select_contact/views_after_auth_screens_chat_select_contact-library.md) + + + +##### [select_contact_view_model](view_model_after_auth_view_models_chat_view_models_select_contact_view_model/view_model_after_auth_view_models_chat_view_models_select_contact_view_model-library.md) + + + +##### [select_language](views_pre_auth_screens_select_language/views_pre_auth_screens_select_language-library.md) + + + +##### [select_organization](views_pre_auth_screens_select_organization/views_pre_auth_screens_select_organization-library.md) + + + +##### [select_organization_view_model](view_model_pre_auth_view_models_select_organization_view_model/view_model_pre_auth_view_models_select_organization_view_model-library.md) + + + +##### [set_url](views_pre_auth_screens_set_url/views_pre_auth_screens_set_url-library.md) + + + +##### [set_url_view_model](view_model_pre_auth_view_models_set_url_view_model/view_model_pre_auth_view_models_set_url_view_model-library.md) + + + +##### [signup_details](views_pre_auth_screens_signup_details/views_pre_auth_screens_signup_details-library.md) + + + +##### [signup_details_view_model](view_model_pre_auth_view_models_signup_details_view_model/view_model_pre_auth_view_models_signup_details_view_model-library.md) + + + +##### [signup_progress_indicator](widgets_signup_progress_indicator/widgets_signup_progress_indicator-library.md) + + + +##### [size_config](services_size_config/services_size_config-library.md) + + + +##### [splash_screen](splash_screen/splash_screen-library.md) + + + +##### [talawa_error_dialog](widgets_talawa_error_dialog/widgets_talawa_error_dialog-library.md) + + + +##### [talawa_error_snackbar](widgets_talawa_error_snackbar/widgets_talawa_error_snackbar-library.md) + + + +##### [talawa_logo](custom_painters_talawa_logo/custom_painters_talawa_logo-library.md) + + + +##### [talawa_plugin_provider](plugins_talawa_plugin_provider/plugins_talawa_plugin_provider-library.md) + + + +##### [task_form](widgets_task_form/widgets_task_form-library.md) + + + +##### [task_model](models_task_task_model/models_task_task_model-library.md) + + + +##### [task_queries](utils_task_queries/utils_task_queries-library.md) + + + +##### [task_schedule](widgets_task_schedule/widgets_task_schedule-library.md) + + + +##### [task_service](services_task_service/services_task_service-library.md) + + + +##### [telegram_logo](custom_painters_telegram_logo/custom_painters_telegram_logo-library.md) + + + +##### [theme_switch](widgets_theme_switch/widgets_theme_switch-library.md) + + + +##### [theme_view_model](view_model_theme_view_model/view_model_theme_view_model-library.md) + + + +##### [timeout](constants_timeout/constants_timeout-library.md) + + + +##### [user_config](services_user_config/services_user_config-library.md) + + + +##### [user_info](models_user_user_info/models_user_user_info-library.md) + + + +##### [user_tasks_page](views_after_auth_screens_tasks_user_tasks_page/views_after_auth_screens_tasks_user_tasks_page-library.md) + + + +##### [validators](utils_validators/utils_validators-library.md) + + + +##### [video_widget](widgets_video_widget/widgets_video_widget-library.md) + + + +##### [waiting_to_join_private_org](views_pre_auth_screens_waiting_to_join_private_org/views_pre_auth_screens_waiting_to_join_private_org-library.md) + + + +##### [waiting_view_model](view_model_pre_auth_view_models_waiting_view_model/view_model_pre_auth_view_models_waiting_view_model-library.md) + + + +##### [whatsapp_logo](custom_painters_whatsapp_logo/custom_painters_whatsapp_logo-library.md) + + + + + + + + + diff --git a/talawa-mobile-docs/locator/connectivity.md b/talawa-mobile-docs/locator/connectivity.md new file mode 100644 index 0000000000..07e3320df7 --- /dev/null +++ b/talawa-mobile-docs/locator/connectivity.md @@ -0,0 +1,36 @@ + + + +# connectivity top-level property + + + + + + + + + +[Connectivity](https://pub.dev/documentation/connectivity_plus/4.0.2/connectivity_plus/Connectivity-class.html) connectivity + +_final_ + + + +

creating GetIt for Connectivity.

+ + + +## Implementation + +```dart +final connectivity = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/databaseFunctions.md b/talawa-mobile-docs/locator/databaseFunctions.md new file mode 100644 index 0000000000..0c16f0a360 --- /dev/null +++ b/talawa-mobile-docs/locator/databaseFunctions.md @@ -0,0 +1,36 @@ + + + +# databaseFunctions top-level property + + + + + + + + + +[DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions-class.md) databaseFunctions + +_final_ + + + +

creating GetIt for DataBaseMutationFunctions.

+ + + +## Implementation + +```dart +final databaseFunctions = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/graphqlConfig.md b/talawa-mobile-docs/locator/graphqlConfig.md new file mode 100644 index 0000000000..68ae14fd69 --- /dev/null +++ b/talawa-mobile-docs/locator/graphqlConfig.md @@ -0,0 +1,36 @@ + + + +# graphqlConfig top-level property + + + + + + + + + +[GraphqlConfig](../services_graphql_config/GraphqlConfig-class.md) graphqlConfig + +_final_ + + + +

creating GetIt for GraphqlConfig.

+ + + +## Implementation + +```dart +final graphqlConfig = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/imageCropper.md b/talawa-mobile-docs/locator/imageCropper.md new file mode 100644 index 0000000000..19e98b7bfd --- /dev/null +++ b/talawa-mobile-docs/locator/imageCropper.md @@ -0,0 +1,36 @@ + + + +# imageCropper top-level property + + + + + + + + + +[ImageCropper](https://pub.dev/documentation/image_cropper/4.0.1/image_cropper/ImageCropper-class.html) imageCropper + +_final_ + + + +

creating GetIt for ImageCropper.

+ + + +## Implementation + +```dart +final imageCropper = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/imagePicker.md b/talawa-mobile-docs/locator/imagePicker.md new file mode 100644 index 0000000000..a2c8b70a01 --- /dev/null +++ b/talawa-mobile-docs/locator/imagePicker.md @@ -0,0 +1,36 @@ + + + +# imagePicker top-level property + + + + + + + + + +[ImagePicker](https://pub.dev/documentation/image_picker/1.0.2/image_picker/ImagePicker-class.html) imagePicker + +_final_ + + + +

creating GetIt for ImagePicker.

+ + + +## Implementation + +```dart +final imagePicker = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/locator-library.md b/talawa-mobile-docs/locator/locator-library.md new file mode 100644 index 0000000000..0df1b4e88b --- /dev/null +++ b/talawa-mobile-docs/locator/locator-library.md @@ -0,0 +1,141 @@ + + + + +# locator library + + + + + + + + + + + + + + + +## Properties + +##### [connectivity](../locator/connectivity.md) → [Connectivity](https://pub.dev/documentation/connectivity_plus/4.0.2/connectivity_plus/Connectivity-class.html) + + + +creating GetIt for Connectivity. +_final_ + + + +##### [databaseFunctions](../locator/databaseFunctions.md) → [DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions-class.md) + + + +creating GetIt for DataBaseMutationFunctions. +_final_ + + + +##### [graphqlConfig](../locator/graphqlConfig.md) → [GraphqlConfig](../services_graphql_config/GraphqlConfig-class.md) + + + +creating GetIt for GraphqlConfig. +_final_ + + + +##### [imageCropper](../locator/imageCropper.md) → [ImageCropper](https://pub.dev/documentation/image_cropper/4.0.1/image_cropper/ImageCropper-class.html) + + + +creating GetIt for ImageCropper. +_final_ + + + +##### [imagePicker](../locator/imagePicker.md) → [ImagePicker](https://pub.dev/documentation/image_picker/1.0.2/image_picker/ImagePicker-class.html) + + + +creating GetIt for ImagePicker. +_final_ + + + +##### [locator](../locator/locator.md) ↔ [GetIt](https://pub.dev/documentation/get_it/7.6.0/get_it/GetIt-class.html) + + + +Intializaing the locator. +_read / write_ + + + +##### [navigationService](../locator/navigationService.md) → [NavigationService](../services_navigation_service/NavigationService-class.md) + + + +creating GetIt for NavigationService. +_final_ + + + +##### [organizationService](../locator/organizationService.md) → [OrganizationService](../services_org_service/OrganizationService-class.md) + + + +creating GetIt for OrganizationService. +_final_ + + + +##### [queries](../locator/queries.md) → [Queries](../utils_queries/Queries-class.md) + + + +creating GetIt for Queries. +_final_ + + + +##### [sizeConfig](../locator/sizeConfig.md) → [SizeConfig](../services_size_config/SizeConfig-class.md) + + + +creating GetIt for SizeConfig. +_final_ + + + +##### [userConfig](../locator/userConfig.md) → [UserConfig](../services_user_config/UserConfig-class.md) + + + +creating GetIt for UserConfig. +_final_ + + + + +## Functions + +##### [setupLocator](../locator/setupLocator.md)() void + + + +This function registers the widgets/objects in "GetIt". + + + + + + + + + + + + diff --git a/talawa-mobile-docs/locator/locator.md b/talawa-mobile-docs/locator/locator.md new file mode 100644 index 0000000000..80b1db4624 --- /dev/null +++ b/talawa-mobile-docs/locator/locator.md @@ -0,0 +1,36 @@ + + + +# locator top-level property + + + + + + + + + +[GetIt](https://pub.dev/documentation/get_it/7.6.0/get_it/GetIt-class.html) locator + +_read / write_ + + + +

Intializaing the locator.

+ + + +## Implementation + +```dart +GetIt locator = GetIt.instance; +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/navigationService.md b/talawa-mobile-docs/locator/navigationService.md new file mode 100644 index 0000000000..2df4db664a --- /dev/null +++ b/talawa-mobile-docs/locator/navigationService.md @@ -0,0 +1,36 @@ + + + +# navigationService top-level property + + + + + + + + + +[NavigationService](../services_navigation_service/NavigationService-class.md) navigationService + +_final_ + + + +

creating GetIt for NavigationService.

+ + + +## Implementation + +```dart +final navigationService = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/organizationService.md b/talawa-mobile-docs/locator/organizationService.md new file mode 100644 index 0000000000..2ed728c6bf --- /dev/null +++ b/talawa-mobile-docs/locator/organizationService.md @@ -0,0 +1,36 @@ + + + +# organizationService top-level property + + + + + + + + + +[OrganizationService](../services_org_service/OrganizationService-class.md) organizationService + +_final_ + + + +

creating GetIt for OrganizationService.

+ + + +## Implementation + +```dart +final organizationService = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/queries.md b/talawa-mobile-docs/locator/queries.md new file mode 100644 index 0000000000..5c95eaf580 --- /dev/null +++ b/talawa-mobile-docs/locator/queries.md @@ -0,0 +1,36 @@ + + + +# queries top-level property + + + + + + + + + +[Queries](../utils_queries/Queries-class.md) queries + +_final_ + + + +

creating GetIt for Queries.

+ + + +## Implementation + +```dart +final queries = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/setupLocator.md b/talawa-mobile-docs/locator/setupLocator.md new file mode 100644 index 0000000000..9fc6a16ec3 --- /dev/null +++ b/talawa-mobile-docs/locator/setupLocator.md @@ -0,0 +1,104 @@ + + + +# setupLocator function + + + + + + + + + + +void setupLocator +() + + + + + +

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

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void setupLocator() { + //services + locator.registerSingleton(NavigationService()); + + //sizeConfig + locator.registerSingleton(SizeConfig()); + + locator.registerSingleton(Validator()); + + //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 + locator.registerSingleton(GraphqlConfig()); + + //databaseMutationFunction + locator.registerSingleton(DataBaseMutationFunctions()); + + //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()); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/locator/sizeConfig.md b/talawa-mobile-docs/locator/sizeConfig.md new file mode 100644 index 0000000000..413c9f786e --- /dev/null +++ b/talawa-mobile-docs/locator/sizeConfig.md @@ -0,0 +1,36 @@ + + + +# sizeConfig top-level property + + + + + + + + + +[SizeConfig](../services_size_config/SizeConfig-class.md) sizeConfig + +_final_ + + + +

creating GetIt for SizeConfig.

+ + + +## Implementation + +```dart +final sizeConfig = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/locator/userConfig.md b/talawa-mobile-docs/locator/userConfig.md new file mode 100644 index 0000000000..cb96aca548 --- /dev/null +++ b/talawa-mobile-docs/locator/userConfig.md @@ -0,0 +1,36 @@ + + + +# userConfig top-level property + + + + + + + + + +[UserConfig](../services_user_config/UserConfig-class.md) userConfig + +_final_ + + + +

creating GetIt for UserConfig.

+ + + +## Implementation + +```dart +final userConfig = locator(); +``` + + + + + + + + diff --git a/talawa-mobile-docs/main/DemoPageView-class.md b/talawa-mobile-docs/main/DemoPageView-class.md new file mode 100644 index 0000000000..08b2e0d15a --- /dev/null +++ b/talawa-mobile-docs/main/DemoPageView-class.md @@ -0,0 +1,190 @@ + + + +# DemoPageView class + + + + + + + + + +

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) +- DemoPageView + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/main/DemoPageView/DemoPageView.md b/talawa-mobile-docs/main/DemoPageView/DemoPageView.md new file mode 100644 index 0000000000..dbddcb13ae --- /dev/null +++ b/talawa-mobile-docs/main/DemoPageView/DemoPageView.md @@ -0,0 +1,29 @@ + + + +# DemoPageView constructor + + + + + + +const +DemoPageView({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const DemoPageView({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/main/DemoPageView/build.md b/talawa-mobile-docs/main/DemoPageView/build.md new file mode 100644 index 0000000000..9fd20f7759 --- /dev/null +++ b/talawa-mobile-docs/main/DemoPageView/build.md @@ -0,0 +1,82 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + FetchPluginList(); + return BaseView( + builder: (context, model, child) => Scaffold( + appBar: AppBar( + title: + Text(AppLocalizations.of(context)!.strictTranslate('Demo Page')), + ), + body: Container( + child: Text(model.title), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/main/DemoViewModel-class.md b/talawa-mobile-docs/main/DemoViewModel-class.md new file mode 100644 index 0000000000..3c395e0ad8 --- /dev/null +++ b/talawa-mobile-docs/main/DemoViewModel-class.md @@ -0,0 +1,191 @@ + + + +# DemoViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- DemoViewModel + + + + + + + + +## Constructors + +[DemoViewModel](../main/DemoViewModel/DemoViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [title](../main/DemoViewModel/title.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +Getter function of the title. +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/main/DemoViewModel/DemoViewModel.md b/talawa-mobile-docs/main/DemoViewModel/DemoViewModel.md new file mode 100644 index 0000000000..1295f2c655 --- /dev/null +++ b/talawa-mobile-docs/main/DemoViewModel/DemoViewModel.md @@ -0,0 +1,24 @@ + + + +# DemoViewModel constructor + + + + + + + +DemoViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/main/DemoViewModel/title.md b/talawa-mobile-docs/main/DemoViewModel/title.md new file mode 100644 index 0000000000..0e55778013 --- /dev/null +++ b/talawa-mobile-docs/main/DemoViewModel/title.md @@ -0,0 +1,42 @@ + + + +# title property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title + + + + + +

Getter function of the title.

+

params: +None +returns:

+
    +
  • String: title of the model
  • +
+ + + +## Implementation + +```dart +String get title => _title; +``` + + + + + + + + diff --git a/talawa-mobile-docs/main/MyApp-class.md b/talawa-mobile-docs/main/MyApp-class.md new file mode 100644 index 0000000000..c76b3c6a3b --- /dev/null +++ b/talawa-mobile-docs/main/MyApp-class.md @@ -0,0 +1,189 @@ + + + +# MyApp class + + + + + + + + + +

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) +- MyApp + + + + + + + + +## Constructors + +[MyApp](../main/MyApp/MyApp.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../main/MyApp/createState.md)() _MyAppState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/main/MyApp/MyApp.md b/talawa-mobile-docs/main/MyApp/MyApp.md new file mode 100644 index 0000000000..d0bf0fead0 --- /dev/null +++ b/talawa-mobile-docs/main/MyApp/MyApp.md @@ -0,0 +1,24 @@ + + + +# MyApp constructor + + + + + + + +MyApp() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/main/MyApp/createState.md b/talawa-mobile-docs/main/MyApp/createState.md new file mode 100644 index 0000000000..b001fadad1 --- /dev/null +++ b/talawa-mobile-docs/main/MyApp/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_MyAppState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_MyAppState createState() => _MyAppState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/main/androidFirebaseOptions.md b/talawa-mobile-docs/main/androidFirebaseOptions.md new file mode 100644 index 0000000000..268b1a3b4c --- /dev/null +++ b/talawa-mobile-docs/main/androidFirebaseOptions.md @@ -0,0 +1,36 @@ + + + +# androidFirebaseOptions top-level property + + + + + + + + + +[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> androidFirebaseOptions + +_read / write_ + + + +

HashMap of Firebase options for android.

+ + + +## Implementation + +```dart +late Map androidFirebaseOptions; +``` + + + + + + + + diff --git a/talawa-mobile-docs/main/channel.md b/talawa-mobile-docs/main/channel.md new file mode 100644 index 0000000000..5f4cada3f9 --- /dev/null +++ b/talawa-mobile-docs/main/channel.md @@ -0,0 +1,36 @@ + + + +# channel top-level property + + + + + + + + + +[AndroidNotificationChannel](https://pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/AndroidNotificationChannel-class.html) channel + +_read / write_ + + + +

Create a AndroidNotificationChannel for heads up notifications.

+ + + +## Implementation + +```dart +late AndroidNotificationChannel channel; +``` + + + + + + + + diff --git a/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md b/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md new file mode 100644 index 0000000000..fb311aba4f --- /dev/null +++ b/talawa-mobile-docs/main/flutterLocalNotificationsPlugin.md @@ -0,0 +1,36 @@ + + + +# flutterLocalNotificationsPlugin top-level property + + + + + + + + + +[FlutterLocalNotificationsPlugin](https://pub.dev/documentation/flutter_local_notifications/15.1.0+1/flutter_local_notifications/FlutterLocalNotificationsPlugin-class.html) flutterLocalNotificationsPlugin + +_read / write_ + + + +

Initialize the FlutterLocalNotificationsPlugin package.

+ + + +## Implementation + +```dart +late FlutterLocalNotificationsPlugin flutterLocalNotificationsPlugin; +``` + + + + + + + + diff --git a/talawa-mobile-docs/main/iosFirebaseOptions.md b/talawa-mobile-docs/main/iosFirebaseOptions.md new file mode 100644 index 0000000000..a92e5f8da7 --- /dev/null +++ b/talawa-mobile-docs/main/iosFirebaseOptions.md @@ -0,0 +1,36 @@ + + + +# iosFirebaseOptions top-level property + + + + + + + + + +[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_ + + + +

HashMap of Firebase options for android.

+ + + +## Implementation + +```dart +late Map iosFirebaseOptions; +``` + + + + + + + + diff --git a/talawa-mobile-docs/main/main-library.md b/talawa-mobile-docs/main/main-library.md new file mode 100644 index 0000000000..1041a7965d --- /dev/null +++ b/talawa-mobile-docs/main/main-library.md @@ -0,0 +1,128 @@ + + + + +# main library + + + + + + + + + + + +## Classes + +##### [DemoPageView](../main/DemoPageView-class.md) + + + +PageView is a scrollable list that works page by page. + + +##### [DemoViewModel](../main/DemoViewModel-class.md) + + + +ViewModel uses property-based data binding to establish a connection. + + +##### [MyApp](../main/MyApp-class.md) + + + +Main widget that sets up the quick actions, internationalization, routing , notifications. + + + + + + +## 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> + + + +HashMap of Firebase options for android. +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + +## Functions + +##### [main](../main/main.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + +First function to initialize the application, invoked automatically. + + + + +##### [setUpFirebase](../main/setUpFirebase.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + +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> + + + +Initializes the firebase keys in the app according to the userplatform (android/iOS). + + + + +##### [setUpFirebaseMessaging](../main/setUpFirebaseMessaging.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + +Set up firebase instance, enbables messaging,listens to icoming messages. + + + + + + + + + + + + diff --git a/talawa-mobile-docs/main/main.md b/talawa-mobile-docs/main/main.md new file mode 100644 index 0000000000..4572429104 --- /dev/null +++ b/talawa-mobile-docs/main/main.md @@ -0,0 +1,95 @@ + + + +# main function + + + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future main() async { + // Returns an instance of the binding that implements WidgetsBinding. + WidgetsFlutterBinding.ensureInitialized(); + + if (!kIsWeb) { + channel = const AndroidNotificationChannel( + 'high_importance_channel', // id + 'High Importance Notifications', // title + 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. + await flutterLocalNotificationsPlugin + .resolvePlatformSpecificImplementation< + AndroidFlutterLocalNotificationsPlugin>() + ?.createNotificationChannel(channel); + } + + final Directory dir = await path.getApplicationDocumentsDirectory(); + Hive + ..init(dir.path) + ..registerAdapter(UserAdapter()) + ..registerAdapter(OrgInfoAdapter()); + + 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) { + await setUpFirebaseKeys(); + + await setUpFirebase(); + await setUpFirebaseMessaging(); + } + } catch (e) { + print("Firebase not working"); + } + + setupLocator(); + // The runApp() function takes the given Widget and makes it the root of the widget tree. + runApp(MyApp()); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/main/setUpFirebase.md b/talawa-mobile-docs/main/setUpFirebase.md new file mode 100644 index 0000000000..91557e294a --- /dev/null +++ b/talawa-mobile-docs/main/setUpFirebase.md @@ -0,0 +1,50 @@ + + + +# setUpFirebase function + + + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future setUpFirebase() async { + await Firebase.initializeApp( + options: DefaultFirebaseOptions.currentPlatform( + androidFirebaseOptions, + iosFirebaseOptions, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/main/setUpFirebaseKeys.md b/talawa-mobile-docs/main/setUpFirebaseKeys.md new file mode 100644 index 0000000000..ca716d0d64 --- /dev/null +++ b/talawa-mobile-docs/main/setUpFirebaseKeys.md @@ -0,0 +1,62 @@ + + + +# setUpFirebaseKeys function + + + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future setUpFirebaseKeys() async { + final androidFirebaseOptionsBox = + await Hive.openBox('androidFirebaseOptions'); + final androidFirebaseOptionsMap = androidFirebaseOptionsBox + .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) { + return MapEntry(key.toString(), value); + }); + } + if (iosFirebaseOptionsMap != null) { + iosFirebaseOptions = iosFirebaseOptionsMap.map((key, value) { + return MapEntry(key.toString(), value); + }); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/main/setUpFirebaseMessaging.md b/talawa-mobile-docs/main/setUpFirebaseMessaging.md new file mode 100644 index 0000000000..d28c01b84c --- /dev/null +++ b/talawa-mobile-docs/main/setUpFirebaseMessaging.md @@ -0,0 +1,79 @@ + + + +# setUpFirebaseMessaging function + + + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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. + await FirebaseMessaging.instance.setForegroundNotificationPresentationOptions( + alert: true, + badge: true, + sound: true, + ); + + FirebaseMessaging.instance + .getInitialMessage() + .then((RemoteMessage? message) {}); + + FirebaseMessaging.onMessage.listen((RemoteMessage message) { + final RemoteNotification? notification = message.notification; + final AndroidNotification? android = message.notification?.android; + if (notification != null && android != null && !kIsWeb) { + flutterLocalNotificationsPlugin.show( + notification.hashCode, + notification.title, + notification.body, + NotificationDetails( + android: AndroidNotificationDetails( + channel.id, + channel.name, + channelDescription: channel.description, + icon: 'launch_background', + ), + ), + ); + } + }); + + FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {}); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md new file mode 100644 index 0000000000..7a107b7674 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md @@ -0,0 +1,133 @@ + + + +# ChatListTileDataModel class + + + + + + + + + +

This class creates JSON code using the JsonSerializable package.

+ + + + + + + + + +**Annotations** + +- @[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.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [id](../models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md new file mode 100644 index 0000000000..c969f9259f --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.fromJson.md @@ -0,0 +1,30 @@ + + + +# ChatListTileDataModel.fromJson constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +factory ChatListTileDataModel.fromJson(Map json) => + _$ChatListTileDataModelFromJson(json); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md new file mode 100644 index 0000000000..ee3832b372 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/ChatListTileDataModel.md @@ -0,0 +1,29 @@ + + + +# ChatListTileDataModel constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +ChatListTileDataModel(this.users, this.id); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md new file mode 100644 index 0000000000..833ed271b4 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/id.md @@ -0,0 +1,32 @@ + + + +# id property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id + +_read / write_ + + + + + + +## Implementation + +```dart +String? id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md new file mode 100644 index 0000000000..8b766cc4e6 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/toJson.md @@ -0,0 +1,34 @@ + + + +# toJson method + + + + + + + + +[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +() + + + + + + + + +## Implementation + +```dart +Map toJson() => _$ChatListTileDataModelToJson(this); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md new file mode 100644 index 0000000000..58ed251cb7 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/ChatListTileDataModel/users.md @@ -0,0 +1,32 @@ + + + +# users property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatUser](../../models_chats_chat_user/ChatUser-class.md)>? users + +_read / write_ + + + + + + +## Implementation + +```dart +List? users; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_list_tile_data_model/models_chats_chat_list_tile_data_model-library.md b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/models_chats_chat_list_tile_data_model-library.md new file mode 100644 index 0000000000..796cc4e881 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_list_tile_data_model/models_chats_chat_list_tile_data_model-library.md @@ -0,0 +1,38 @@ + + + + +# chat_list_tile_data_model library + + + + + + + + + + + +## Classes + +##### [ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) + + + +This class creates JSON code using the JsonSerializable package. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md new file mode 100644 index 0000000000..4c38ab4232 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage-class.md @@ -0,0 +1,151 @@ + + + +# ChatMessage class + + + + + + + + + +

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

+ + + + + + + + + +**Annotations** + +- @[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.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [id](../models_chats_chat_message/ChatMessage/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [messageContent](../models_chats_chat_message/ChatMessage/messageContent.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [receiver](../models_chats_chat_message/ChatMessage/receiver.md) ↔ [ChatUser](../models_chats_chat_user/ChatUser-class.md)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [sender](../models_chats_chat_message/ChatMessage/sender.md) ↔ [ChatUser](../models_chats_chat_user/ChatUser-class.md)? + + + + +_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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md new file mode 100644 index 0000000000..514060af9f --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.fromJson.md @@ -0,0 +1,30 @@ + + + +# ChatMessage.fromJson constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +factory ChatMessage.fromJson(Map json) => + _$ChatMessageFromJson(json); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md new file mode 100644 index 0000000000..78e85c05da --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/ChatMessage.md @@ -0,0 +1,34 @@ + + + +# ChatMessage constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +ChatMessage( + this.id, + this.sender, + this.messageContent, + this.receiver, +); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md new file mode 100644 index 0000000000..833ed271b4 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/id.md @@ -0,0 +1,32 @@ + + + +# id property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id + +_read / write_ + + + + + + +## Implementation + +```dart +String? id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md new file mode 100644 index 0000000000..372a20d7ae --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/messageContent.md @@ -0,0 +1,32 @@ + + + +# messageContent property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? messageContent + +_read / write_ + + + + + + +## Implementation + +```dart +String? messageContent; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md new file mode 100644 index 0000000000..7887b8cf45 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/receiver.md @@ -0,0 +1,32 @@ + + + +# receiver property + + + + + + + +[ChatUser](../../models_chats_chat_user/ChatUser-class.md)? receiver + +_read / write_ + + + + + + +## Implementation + +```dart +ChatUser? receiver; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md new file mode 100644 index 0000000000..4b8806efbe --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/sender.md @@ -0,0 +1,32 @@ + + + +# sender property + + + + + + + +[ChatUser](../../models_chats_chat_user/ChatUser-class.md)? sender + +_read / write_ + + + + + + +## Implementation + +```dart +ChatUser? sender; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md new file mode 100644 index 0000000000..0f7c47e942 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/ChatMessage/toJson.md @@ -0,0 +1,34 @@ + + + +# toJson method + + + + + + + + +[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +() + + + + + + + + +## Implementation + +```dart +Map toJson() => _$ChatMessageToJson(this); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_message/models_chats_chat_message-library.md b/talawa-mobile-docs/models_chats_chat_message/models_chats_chat_message-library.md new file mode 100644 index 0000000000..b21336f764 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_message/models_chats_chat_message-library.md @@ -0,0 +1,38 @@ + + + + +# chat_message library + + + + + + + + + + + +## Classes + +##### [ChatMessage](../models_chats_chat_message/ChatMessage-class.md) + + + +This class creates JSON code for chat message using the JsonSerializable package. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md new file mode 100644 index 0000000000..18020e727c --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser-class.md @@ -0,0 +1,142 @@ + + + +# ChatUser class + + + + + + + + + +

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

+ + + + + + + + + +**Annotations** + +- @[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.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)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [id](../models_chats_chat_user/ChatUser/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [image](../models_chats_chat_user/ChatUser/image.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md new file mode 100644 index 0000000000..4283c825f6 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.fromJson.md @@ -0,0 +1,30 @@ + + + +# ChatUser.fromJson constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +factory ChatUser.fromJson(Map json) => + _$ChatUserFromJson(json); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md new file mode 100644 index 0000000000..5b6db09b4f --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser/ChatUser.md @@ -0,0 +1,29 @@ + + + +# ChatUser constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +ChatUser({this.firstName, this.id, this.image}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md new file mode 100644 index 0000000000..0fbc847279 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser/firstName.md @@ -0,0 +1,32 @@ + + + +# firstName property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstName + +_read / write_ + + + + + + +## Implementation + +```dart +String? firstName; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md new file mode 100644 index 0000000000..833ed271b4 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser/id.md @@ -0,0 +1,32 @@ + + + +# id property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id + +_read / write_ + + + + + + +## Implementation + +```dart +String? id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md new file mode 100644 index 0000000000..db1007542e --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser/image.md @@ -0,0 +1,32 @@ + + + +# image property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? image + +_read / write_ + + + + + + +## Implementation + +```dart +String? image; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md b/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md new file mode 100644 index 0000000000..8c0124f88f --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/ChatUser/toJson.md @@ -0,0 +1,34 @@ + + + +# toJson method + + + + + + + + +[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic> toJson +() + + + + + + + + +## Implementation + +```dart +Map toJson() => _$ChatUserToJson(this); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_chats_chat_user/models_chats_chat_user-library.md b/talawa-mobile-docs/models_chats_chat_user/models_chats_chat_user-library.md new file mode 100644 index 0000000000..793e8e89e8 --- /dev/null +++ b/talawa-mobile-docs/models_chats_chat_user/models_chats_chat_user-library.md @@ -0,0 +1,38 @@ + + + + +# chat_user library + + + + + + + + + + + +## Classes + +##### [ChatUser](../models_chats_chat_user/ChatUser-class.md) + + + +This class creates JSON code for chat user using the JsonSerializable package. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment-class.md b/talawa-mobile-docs/models_comment_comment_model/Comment-class.md new file mode 100644 index 0000000000..e00460d307 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment-class.md @@ -0,0 +1,141 @@ + + + +# Comment class + + + + + + + + + +

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.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)? + + + + +_read / write_ + + + +##### [creator](../models_comment_comment_model/Comment/creator.md) ↔ [User](../models_user_user_info/User-class.md)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [likeCount](../models_comment_comment_model/Comment/likeCount.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [post](../models_comment_comment_model/Comment/post.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [text](../models_comment_comment_model/Comment/text.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md b/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md new file mode 100644 index 0000000000..15a9021708 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.fromJson.md @@ -0,0 +1,43 @@ + + + +# Comment.fromJson constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +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. + : User.fromJson( + json['creator'] as Map, + fromOrg: true, + ), + post: json['post'] as String?, + likeCount: json['likeCount'] as String?, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md b/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md new file mode 100644 index 0000000000..120962bcc8 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/Comment.md @@ -0,0 +1,29 @@ + + + +# Comment constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +Comment({this.text, this.createdAt, this.creator, this.post, this.likeCount}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md b/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md new file mode 100644 index 0000000000..6f4a3a12ef --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/createdAt.md @@ -0,0 +1,32 @@ + + + +# createdAt property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? createdAt + +_read / write_ + + + + + + +## Implementation + +```dart +String? createdAt; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md b/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md new file mode 100644 index 0000000000..8dcdc334b5 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/creator.md @@ -0,0 +1,32 @@ + + + +# creator property + + + + + + + +[User](../../models_user_user_info/User-class.md)? creator + +_read / write_ + + + + + + +## Implementation + +```dart +User? creator; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md b/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md new file mode 100644 index 0000000000..d4ba33db56 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/likeCount.md @@ -0,0 +1,32 @@ + + + +# likeCount property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? likeCount + +_read / write_ + + + + + + +## Implementation + +```dart +String? likeCount; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/post.md b/talawa-mobile-docs/models_comment_comment_model/Comment/post.md new file mode 100644 index 0000000000..60ba62c806 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/post.md @@ -0,0 +1,32 @@ + + + +# post property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? post + +_read / write_ + + + + + + +## Implementation + +```dart +String? post; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/Comment/text.md b/talawa-mobile-docs/models_comment_comment_model/Comment/text.md new file mode 100644 index 0000000000..3e3c81333a --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/Comment/text.md @@ -0,0 +1,32 @@ + + + +# text property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? text + +_read / write_ + + + + + + +## Implementation + +```dart +String? text; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_comment_comment_model/models_comment_comment_model-library.md b/talawa-mobile-docs/models_comment_comment_model/models_comment_comment_model-library.md new file mode 100644 index 0000000000..85d3df1ba6 --- /dev/null +++ b/talawa-mobile-docs/models_comment_comment_model/models_comment_comment_model-library.md @@ -0,0 +1,38 @@ + + + + +# comment_model library + + + + + + + + + + + +## Classes + +##### [Comment](../models_comment_comment_model/Comment-class.md) + + + +This class returns a Comment instance. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event-class.md b/talawa-mobile-docs/models_events_event_model/Event-class.md new file mode 100644 index 0000000000..0ab22c2ff6 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event-class.md @@ -0,0 +1,285 @@ + + + +# Event class + + + + + + + + + +

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.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)>? + + + + +_read / write_ + + + +##### [allDay](../models_events_event_model/Event/allDay.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? + + + + +_read / write_ + + + +##### [attendees](../models_events_event_model/Event/attendees.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [creator](../models_events_event_model/Event/creator.md) ↔ [User](../models_user_user_info/User-class.md)? + + + + +_read / write_ + + + +##### [description](../models_events_event_model/Event/description.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [endDate](../models_events_event_model/Event/endDate.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [endTime](../models_events_event_model/Event/endTime.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [id](../models_events_event_model/Event/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [isPublic](../models_events_event_model/Event/isPublic.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? + + + + +_read / write_ + + + +##### [isRegisterable](../models_events_event_model/Event/isRegisterable.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? + + + + +_read / write_ + + + +##### [isRegistered](../models_events_event_model/Event/isRegistered.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? + + + + +_read / write_ + + + +##### [latitude](../models_events_event_model/Event/latitude.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [location](../models_events_event_model/Event/location.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [longitude](../models_events_event_model/Event/longitude.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [organization](../models_events_event_model/Event/organization.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? + + + + +_read / write_ + + + +##### [recurrence](../models_events_event_model/Event/recurrence.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [recurring](../models_events_event_model/Event/recurring.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? + + + + +_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)>? + + + + +_read / write_ + + + +##### [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_ + + + +##### [startDate](../models_events_event_model/Event/startDate.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [startTime](../models_events_event_model/Event/startTime.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [title](../models_events_event_model/Event/title.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md b/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md new file mode 100644 index 0000000000..9a7ea61a0c --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/Event.fromJson.md @@ -0,0 +1,72 @@ + + + +# Event.fromJson constructor + + + + + + + +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) + + + + + +## Implementation + +```dart +factory Event.fromJson( + Map json, +) { + return Event( + id: json['_id'] as String, + title: json['title'] as String?, + description: json['description'] as String?, + attendees: json['attendees'] as String?, + location: json['location'] as String?, + longitude: json['longitude'] as double?, + latitude: json['latitude'] as double?, + recurring: json['recurring'] as bool?, + allDay: json['allDay'] as bool?, + startDate: json['startDate'] as String?, + endDate: json['endDate'] as String?, + startTime: json['startTime'] as String?, + endTime: json['endTime'] as String?, + recurrence: json['recurrence'] as String?, + isPublic: json['isPublic'] as bool?, + isRegistered: json['isRegistered'] as bool?, + isRegisterable: json['isRegisterable'] as bool?, + creator: json['creator'] == null + ? null + //Creating a new User instance from a map structure. + : User.fromJson( + 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), + admins: json['admins'] == null + ? null + : (json['admins'] as List?) + ?.map( + (e) => User.fromJson(e as Map, fromOrg: true), + ) + .toList(), + registrants: (json['registrants'] as List?) + ?.map((e) => User.fromJson(e as Map, fromOrg: false)) + .toList(), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/Event.md b/talawa-mobile-docs/models_events_event_model/Event/Event.md new file mode 100644 index 0000000000..399d73b899 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/Event.md @@ -0,0 +1,51 @@ + + + +# Event constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +Event({ + this.id, + this.title, + this.description, + this.attendees, + this.location, + this.latitude, + this.longitude, + this.recurring, + this.allDay, + this.startDate, + this.endDate, + this.startTime, + this.endTime, + this.recurrence, + this.isPublic, + this.isRegistered, + this.isRegisterable, + this.creator, + this.organization, + this.admins, + this.registrants, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/admins.md b/talawa-mobile-docs/models_events_event_model/Event/admins.md new file mode 100644 index 0000000000..d97a3be09a --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/admins.md @@ -0,0 +1,32 @@ + + + +# admins property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? admins + +_read / write_ + + + + + + +## Implementation + +```dart +List? admins; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/allDay.md b/talawa-mobile-docs/models_events_event_model/Event/allDay.md new file mode 100644 index 0000000000..630774560d --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/allDay.md @@ -0,0 +1,32 @@ + + + +# allDay property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? allDay + +_read / write_ + + + + + + +## Implementation + +```dart +bool? allDay; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/attendees.md b/talawa-mobile-docs/models_events_event_model/Event/attendees.md new file mode 100644 index 0000000000..203b6c667c --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/attendees.md @@ -0,0 +1,32 @@ + + + +# attendees property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? attendees + +_read / write_ + + + + + + +## Implementation + +```dart +String? attendees; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/creator.md b/talawa-mobile-docs/models_events_event_model/Event/creator.md new file mode 100644 index 0000000000..8dcdc334b5 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/creator.md @@ -0,0 +1,32 @@ + + + +# creator property + + + + + + + +[User](../../models_user_user_info/User-class.md)? creator + +_read / write_ + + + + + + +## Implementation + +```dart +User? creator; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/description.md b/talawa-mobile-docs/models_events_event_model/Event/description.md new file mode 100644 index 0000000000..274483eb8f --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/description.md @@ -0,0 +1,32 @@ + + + +# description property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description + +_read / write_ + + + + + + +## Implementation + +```dart +String? description; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/endDate.md b/talawa-mobile-docs/models_events_event_model/Event/endDate.md new file mode 100644 index 0000000000..71cdad30e2 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/endDate.md @@ -0,0 +1,32 @@ + + + +# endDate property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endDate + +_read / write_ + + + + + + +## Implementation + +```dart +String? endDate; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/endTime.md b/talawa-mobile-docs/models_events_event_model/Event/endTime.md new file mode 100644 index 0000000000..b494d8a612 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/endTime.md @@ -0,0 +1,32 @@ + + + +# endTime property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? endTime + +_read / write_ + + + + + + +## Implementation + +```dart +String? endTime; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/id.md b/talawa-mobile-docs/models_events_event_model/Event/id.md new file mode 100644 index 0000000000..833ed271b4 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/id.md @@ -0,0 +1,32 @@ + + + +# id property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? id + +_read / write_ + + + + + + +## Implementation + +```dart +String? id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/isPublic.md b/talawa-mobile-docs/models_events_event_model/Event/isPublic.md new file mode 100644 index 0000000000..115e149ff6 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/isPublic.md @@ -0,0 +1,32 @@ + + + +# isPublic property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isPublic + +_read / write_ + + + + + + +## Implementation + +```dart +bool? isPublic; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md b/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md new file mode 100644 index 0000000000..80a87ac5df --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/isRegisterable.md @@ -0,0 +1,32 @@ + + + +# isRegisterable property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegisterable + +_read / write_ + + + + + + +## Implementation + +```dart +bool? isRegisterable; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md b/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md new file mode 100644 index 0000000000..0b7abce174 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/isRegistered.md @@ -0,0 +1,32 @@ + + + +# isRegistered property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? isRegistered + +_read / write_ + + + + + + +## Implementation + +```dart +bool? isRegistered; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/latitude.md b/talawa-mobile-docs/models_events_event_model/Event/latitude.md new file mode 100644 index 0000000000..0f6aa819fa --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/latitude.md @@ -0,0 +1,32 @@ + + + +# latitude property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? latitude + +_read / write_ + + + + + + +## Implementation + +```dart +double? latitude; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/location.md b/talawa-mobile-docs/models_events_event_model/Event/location.md new file mode 100644 index 0000000000..d2fde26906 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/location.md @@ -0,0 +1,32 @@ + + + +# location property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? location + +_read / write_ + + + + + + +## Implementation + +```dart +String? location; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/longitude.md b/talawa-mobile-docs/models_events_event_model/Event/longitude.md new file mode 100644 index 0000000000..0b3b006608 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/longitude.md @@ -0,0 +1,32 @@ + + + +# longitude property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? longitude + +_read / write_ + + + + + + +## Implementation + +```dart +double? longitude; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/organization.md b/talawa-mobile-docs/models_events_event_model/Event/organization.md new file mode 100644 index 0000000000..8138745ecc --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/organization.md @@ -0,0 +1,32 @@ + + + +# organization property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization + +_read / write_ + + + + + + +## Implementation + +```dart +OrgInfo? organization; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/recurrence.md b/talawa-mobile-docs/models_events_event_model/Event/recurrence.md new file mode 100644 index 0000000000..95763e6de5 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/recurrence.md @@ -0,0 +1,32 @@ + + + +# recurrence property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? recurrence + +_read / write_ + + + + + + +## Implementation + +```dart +String? recurrence; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/recurring.md b/talawa-mobile-docs/models_events_event_model/Event/recurring.md new file mode 100644 index 0000000000..b9223bf40e --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/recurring.md @@ -0,0 +1,32 @@ + + + +# recurring property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? recurring + +_read / write_ + + + + + + +## Implementation + +```dart +bool? recurring; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/registrants.md b/talawa-mobile-docs/models_events_event_model/Event/registrants.md new file mode 100644 index 0000000000..77c0d2342c --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/registrants.md @@ -0,0 +1,32 @@ + + + +# registrants property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)>? registrants + +_read / write_ + + + + + + +## Implementation + +```dart +List? registrants; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/startDate.md b/talawa-mobile-docs/models_events_event_model/Event/startDate.md new file mode 100644 index 0000000000..a3a2683688 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/startDate.md @@ -0,0 +1,32 @@ + + + +# startDate property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startDate + +_read / write_ + + + + + + +## Implementation + +```dart +String? startDate; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/startTime.md b/talawa-mobile-docs/models_events_event_model/Event/startTime.md new file mode 100644 index 0000000000..45d78625a0 --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/startTime.md @@ -0,0 +1,32 @@ + + + +# startTime property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? startTime + +_read / write_ + + + + + + +## Implementation + +```dart +String? startTime; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/Event/title.md b/talawa-mobile-docs/models_events_event_model/Event/title.md new file mode 100644 index 0000000000..79dd02590f --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/Event/title.md @@ -0,0 +1,32 @@ + + + +# title property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? title + +_read / write_ + + + + + + +## Implementation + +```dart +String? title; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_events_event_model/models_events_event_model-library.md b/talawa-mobile-docs/models_events_event_model/models_events_event_model-library.md new file mode 100644 index 0000000000..2ccf09efae --- /dev/null +++ b/talawa-mobile-docs/models_events_event_model/models_events_event_model-library.md @@ -0,0 +1,38 @@ + + + + +# event_model library + + + + + + + + + + + +## Classes + +##### [Event](../models_events_event_model/Event-class.md) + + + +This class creates an event model and returns an Event instance. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/Language-class.md b/talawa-mobile-docs/models_language_language_model/Language-class.md new file mode 100644 index 0000000000..b17705b6bb --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/Language-class.md @@ -0,0 +1,128 @@ + + + +# Language class + + + + + + + + + +

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}) + + + + +## Properties + +##### [countryCode](../models_language_language_model/Language/countryCode.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [langCode](../models_language_language_model/Language/langCode.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [langName](../models_language_language_model/Language/langName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [langSample](../models_language_language_model/Language/langSample.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/Language/Language.md b/talawa-mobile-docs/models_language_language_model/Language/Language.md new file mode 100644 index 0000000000..04c52d10b2 --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/Language/Language.md @@ -0,0 +1,34 @@ + + + +# Language constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +Language({ + required this.countryCode, + required this.langCode, + required this.langName, + required this.langSample, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/Language/countryCode.md b/talawa-mobile-docs/models_language_language_model/Language/countryCode.md new file mode 100644 index 0000000000..c832d751b5 --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/Language/countryCode.md @@ -0,0 +1,32 @@ + + + +# countryCode property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) countryCode + +_final_ + + + + + + +## Implementation + +```dart +final String countryCode; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/Language/langCode.md b/talawa-mobile-docs/models_language_language_model/Language/langCode.md new file mode 100644 index 0000000000..e6ca157cff --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/Language/langCode.md @@ -0,0 +1,32 @@ + + + +# langCode property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) langCode + +_final_ + + + + + + +## Implementation + +```dart +final String langCode; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/Language/langName.md b/talawa-mobile-docs/models_language_language_model/Language/langName.md new file mode 100644 index 0000000000..95636992c9 --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/Language/langName.md @@ -0,0 +1,32 @@ + + + +# langName property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) langName + +_final_ + + + + + + +## Implementation + +```dart +final String langName; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/Language/langSample.md b/talawa-mobile-docs/models_language_language_model/Language/langSample.md new file mode 100644 index 0000000000..0dbe17a121 --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/Language/langSample.md @@ -0,0 +1,32 @@ + + + +# langSample property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) langSample + +_final_ + + + + + + +## Implementation + +```dart +final String langSample; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_language_language_model/models_language_language_model-library.md b/talawa-mobile-docs/models_language_language_model/models_language_language_model-library.md new file mode 100644 index 0000000000..72573e5ab5 --- /dev/null +++ b/talawa-mobile-docs/models_language_language_model/models_language_language_model-library.md @@ -0,0 +1,38 @@ + + + + +# language_model library + + + + + + + + + + + +## Classes + +##### [Language](../models_language_language_model/Language-class.md) + + + +This class creates an langauge model. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md new file mode 100644 index 0000000000..f6a0d3d742 --- /dev/null +++ b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs-class.md @@ -0,0 +1,109 @@ + + + +# MainScreenArgs class + + + + + + + + + + + + + +## 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}) + + + + +## Properties + +##### [fromSignUp](../models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [mainScreenIndex](../models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + + +_final_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md new file mode 100644 index 0000000000..7e83ed6f2f --- /dev/null +++ b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/MainScreenArgs.md @@ -0,0 +1,29 @@ + + + +# MainScreenArgs constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +MainScreenArgs({this.fromSignUp = false, required this.mainScreenIndex}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md new file mode 100644 index 0000000000..65dbae94ca --- /dev/null +++ b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/fromSignUp.md @@ -0,0 +1,32 @@ + + + +# fromSignUp property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) fromSignUp + +_final_ + + + + + + +## Implementation + +```dart +final bool fromSignUp; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md new file mode 100644 index 0000000000..570058a349 --- /dev/null +++ b/talawa-mobile-docs/models_mainscreen_navigation_args/MainScreenArgs/mainScreenIndex.md @@ -0,0 +1,32 @@ + + + +# mainScreenIndex property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex + +_final_ + + + + + + +## Implementation + +```dart +final int mainScreenIndex; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_mainscreen_navigation_args/models_mainscreen_navigation_args-library.md b/talawa-mobile-docs/models_mainscreen_navigation_args/models_mainscreen_navigation_args-library.md new file mode 100644 index 0000000000..d141630374 --- /dev/null +++ b/talawa-mobile-docs/models_mainscreen_navigation_args/models_mainscreen_navigation_args-library.md @@ -0,0 +1,38 @@ + + + + +# mainscreen_navigation_args library + + + + + + + + + + + +## Classes + +##### [MainScreenArgs](../models_mainscreen_navigation_args/MainScreenArgs-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/Options-class.md b/talawa-mobile-docs/models_options_options/Options-class.md new file mode 100644 index 0000000000..f5c9eabca0 --- /dev/null +++ b/talawa-mobile-docs/models_options_options/Options-class.md @@ -0,0 +1,128 @@ + + + +# Options class + + + + + + + + + +

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}) + + + + +## Properties + +##### [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_ + + + +##### [icon](../models_options_options/Options/icon.md) ↔ [Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [subtitle](../models_options_options/Options/subtitle.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read / write_ + + + +##### [title](../models_options_options/Options/title.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read / write_ + + + +##### [trailingIconButton](../models_options_options/Options/trailingIconButton.md) ↔ [IconButton](https://api.flutter.dev/flutter/material/IconButton-class.html)? + + + + +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/Options/Options.md b/talawa-mobile-docs/models_options_options/Options/Options.md new file mode 100644 index 0000000000..ec36ee551f --- /dev/null +++ b/talawa-mobile-docs/models_options_options/Options/Options.md @@ -0,0 +1,34 @@ + + + +# Options constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +Options({ + required this.icon, + required this.title, + required this.subtitle, + this.trailingIconButton, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/Options/icon.md b/talawa-mobile-docs/models_options_options/Options/icon.md new file mode 100644 index 0000000000..4e90354722 --- /dev/null +++ b/talawa-mobile-docs/models_options_options/Options/icon.md @@ -0,0 +1,32 @@ + + + +# icon property + + + + + + + +[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) icon + +_read / write_ + + + + + + +## Implementation + +```dart +Widget icon; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/Options/subtitle.md b/talawa-mobile-docs/models_options_options/Options/subtitle.md new file mode 100644 index 0000000000..49c653f7ef --- /dev/null +++ b/talawa-mobile-docs/models_options_options/Options/subtitle.md @@ -0,0 +1,32 @@ + + + +# subtitle property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) subtitle + +_read / write_ + + + + + + +## Implementation + +```dart +String subtitle; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/Options/title.md b/talawa-mobile-docs/models_options_options/Options/title.md new file mode 100644 index 0000000000..7f3fec8c9e --- /dev/null +++ b/talawa-mobile-docs/models_options_options/Options/title.md @@ -0,0 +1,32 @@ + + + +# title property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title + +_read / write_ + + + + + + +## Implementation + +```dart +String title; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md b/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md new file mode 100644 index 0000000000..d9b9f553f1 --- /dev/null +++ b/talawa-mobile-docs/models_options_options/Options/trailingIconButton.md @@ -0,0 +1,32 @@ + + + +# trailingIconButton property + + + + + + + +[IconButton](https://api.flutter.dev/flutter/material/IconButton-class.html)? trailingIconButton + +_read / write_ + + + + + + +## Implementation + +```dart +IconButton? trailingIconButton; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_options_options/models_options_options-library.md b/talawa-mobile-docs/models_options_options/models_options_options-library.md new file mode 100644 index 0000000000..259ad57477 --- /dev/null +++ b/talawa-mobile-docs/models_options_options/models_options_options-library.md @@ -0,0 +1,38 @@ + + + + +# options library + + + + + + + + + + + +## Classes + +##### [Options](../models_options_options/Options-class.md) + + + +This class creates a Option model. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md new file mode 100644 index 0000000000..2be8742b9f --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo-class.md @@ -0,0 +1,187 @@ + + + +# OrgInfo class + + + + + + + + + +

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

+ + + + + + + + + +**Annotations** + +- @[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.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)>? + + + + +_read / write_ + + + +##### [creatorInfo](../models_organization_org_info/OrgInfo/creatorInfo.md) ↔ [User](../models_user_user_info/User-class.md)? + + + + +_read / write_ + + + +##### [description](../models_organization_org_info/OrgInfo/description.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [id](../models_organization_org_info/OrgInfo/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [image](../models_organization_org_info/OrgInfo/image.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [isPublic](../models_organization_org_info/OrgInfo/isPublic.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)? + + + + +_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)>? + + + + +_read / write_ + + + +##### [name](../models_organization_org_info/OrgInfo/name.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + + + +## 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)> + + + + + + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md new file mode 100644 index 0000000000..45cbc5eaeb --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.fromJson.md @@ -0,0 +1,67 @@ + + + +# OrgInfo.fromJson constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +factory OrgInfo.fromJson( + Map json1, { + bool memberRequest = false, +}) { + 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, + name: json['name'] != null ? json['name'] as String? : null, + description: + json['description'] != null ? json['description'] as String? : null, + isPublic: json['isPublic'] != null ? json['isPublic'] as bool? : null, + creatorInfo: json['creator'] != null + ? User.fromJson( + json['creator'] as Map, + fromOrg: true, + ) + : null, + members: json['members'] != null + ? (json['members'] as List?) + ?.map( + (e) => User.fromJson(e as Map, fromOrg: true), + ) + .toList() + : null, + admins: json['admins'] != null + ? (json['admins'] as List?) + ?.map( + (e) => User.fromJson(e as Map, fromOrg: true), + ) + .toList() + : null, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md new file mode 100644 index 0000000000..ec3cdccb2b --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/OrgInfo.md @@ -0,0 +1,38 @@ + + + +# OrgInfo constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +OrgInfo({ + this.admins, + this.members, + this.creatorInfo, + this.description, + this.id, + this.image, + this.isPublic, + this.name, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md new file mode 100644 index 0000000000..ed855ec72f --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/admins.md @@ -0,0 +1,36 @@ + + + +# admins property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(3) +List? admins; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md new file mode 100644 index 0000000000..96f5890332 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/creatorInfo.md @@ -0,0 +1,36 @@ + + + +# creatorInfo property + + + + + + + +**Annotations** + +- @[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_ + + + + + + +## Implementation + +```dart +@HiveField(7) +User? creatorInfo; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md new file mode 100644 index 0000000000..0dd524bef7 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/description.md @@ -0,0 +1,36 @@ + + + +# description property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(5) +String? description; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md new file mode 100644 index 0000000000..f675364e67 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/fromJsonToList.md @@ -0,0 +1,41 @@ + + + +# fromJsonToList method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +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/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md new file mode 100644 index 0000000000..41593eb6c9 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/id.md @@ -0,0 +1,36 @@ + + + +# id property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(1) +String? id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md new file mode 100644 index 0000000000..307a6d8940 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/image.md @@ -0,0 +1,36 @@ + + + +# image property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(0) +String? image; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md new file mode 100644 index 0000000000..2ab544f2ae --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/isPublic.md @@ -0,0 +1,36 @@ + + + +# isPublic property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(6) +bool? isPublic; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md new file mode 100644 index 0000000000..0613169d66 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/members.md @@ -0,0 +1,36 @@ + + + +# members property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(4) +List? members; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md b/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md new file mode 100644 index 0000000000..e69ccaed40 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfo/name.md @@ -0,0 +1,36 @@ + + + +# name property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(2) +String? name; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md new file mode 100644 index 0000000000..1593510228 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter-class.md @@ -0,0 +1,130 @@ + + + +# OrgInfoAdapter class + + + + + + + + + + + + +**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)> +- OrgInfoAdapter + + + + + + + + +## Constructors + +[OrgInfoAdapter](../models_organization_org_info/OrgInfoAdapter/OrgInfoAdapter.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [typeId](../models_organization_org_info/OrgInfoAdapter/typeId.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + +Called for type registration +_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 + + + +Invoked when a non-existent method or property is accessed. +_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) + + + +Is called when a value has to be decoded. +_override_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_override_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/OrgInfoAdapter.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/OrgInfoAdapter.md new file mode 100644 index 0000000000..82ac945fd9 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/OrgInfoAdapter.md @@ -0,0 +1,24 @@ + + + +# OrgInfoAdapter constructor + + + + + + + +OrgInfoAdapter() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md new file mode 100644 index 0000000000..3f59c03a5c --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/hashCode.md @@ -0,0 +1,65 @@ + + + +# hashCode property + + + + + + + + + +**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_ + + + +

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 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 ==. +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. +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.

+ + + +## Implementation + +```dart +@override +int get hashCode => typeId.hashCode; +``` + + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/operator_equals.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/operator_equals.md new file mode 100644 index 0000000000..5a89901e12 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/operator_equals.md @@ -0,0 +1,67 @@ + + + +# operator == method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) operator == +([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) + +_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 +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, +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.

+ + + +## Implementation + +```dart +@override +bool operator ==(Object other) => + identical(this, other) || + other is OrgInfoAdapter && + runtimeType == other.runtimeType && + typeId == other.typeId; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md new file mode 100644 index 0000000000..730b1101e2 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/read.md @@ -0,0 +1,52 @@ + + + +# read method + + + + + + + +- @[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) + +_override_ + + + +

Is called when a value has to be decoded.

+ + + +## Implementation + +```dart +@override +OrgInfo read(BinaryReader reader) { + final numOfFields = reader.readByte(); + 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(), + creatorInfo: fields[7] as User?, + description: fields[5] as String?, + id: fields[1] as String?, + image: fields[0] as String?, + isPublic: fields[6] as bool?, + name: fields[2] as String?, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md new file mode 100644 index 0000000000..185e25a2c0 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/typeId.md @@ -0,0 +1,37 @@ + + + +# typeId property + + + + + + + +**Annotations** + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) typeId + +_final_ + + + +

Called for type registration

+ + + +## Implementation + +```dart +@override +final int typeId = 2; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md new file mode 100644 index 0000000000..65e6d9ac02 --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/OrgInfoAdapter/write.md @@ -0,0 +1,56 @@ + + + +# write method + + + + + + + +- @[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) + +_override_ + + + +

Is called when a value has to be encoded.

+ + + +## Implementation + +```dart +@override +void write(BinaryWriter writer, OrgInfo obj) { + writer + ..writeByte(8) + ..writeByte(0) + ..write(obj.image) + ..writeByte(1) + ..write(obj.id) + ..writeByte(2) + ..write(obj.name) + ..writeByte(3) + ..write(obj.admins) + ..writeByte(4) + ..write(obj.members) + ..writeByte(5) + ..write(obj.description) + ..writeByte(6) + ..write(obj.isPublic) + ..writeByte(7) + ..write(obj.creatorInfo); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_organization_org_info/models_organization_org_info-library.md b/talawa-mobile-docs/models_organization_org_info/models_organization_org_info-library.md new file mode 100644 index 0000000000..1372e1194e --- /dev/null +++ b/talawa-mobile-docs/models_organization_org_info/models_organization_org_info-library.md @@ -0,0 +1,45 @@ + + + + +# org_info library + + + + + + + + + + + +## Classes + +##### [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + +This class creates an organization-information model and returns an OrgInfo instance. + + +##### [OrgInfoAdapter](../models_organization_org_info/OrgInfoAdapter-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Comments-class.md b/talawa-mobile-docs/models_post_post_model/Comments-class.md new file mode 100644 index 0000000000..d239109404 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Comments-class.md @@ -0,0 +1,114 @@ + + + +# Comments class + + + + + + + + + +

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.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md b/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md new file mode 100644 index 0000000000..7edc282975 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Comments/Comments.fromJson.md @@ -0,0 +1,38 @@ + + + +# Comments.fromJson constructor + + + + + + + +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: +None +returns:

+
    +
  • Map<String, dynamic>: Dart object is returned.
  • +
+ + + +## Implementation + +```dart +Comments.fromJson(Map json) { + sId = json['_id'] as String?; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Comments/Comments.md b/talawa-mobile-docs/models_post_post_model/Comments/Comments.md new file mode 100644 index 0000000000..ea2aab3be7 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Comments/Comments.md @@ -0,0 +1,29 @@ + + + +# Comments constructor + + + + + + + +Comments({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId}) + + + + + +## Implementation + +```dart +Comments({this.sId}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Comments/sId.md b/talawa-mobile-docs/models_post_post_model/Comments/sId.md new file mode 100644 index 0000000000..398d78335e --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Comments/sId.md @@ -0,0 +1,37 @@ + + + +# sId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId + +_read / write_ + + + +

these are dart object.

+

params:

+
    +
  • sId : unique identifier for post
  • +
+ + + +## Implementation + +```dart +String? sId; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Comments/toJson.md b/talawa-mobile-docs/models_post_post_model/Comments/toJson.md new file mode 100644 index 0000000000..41171d83c7 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Comments/toJson.md @@ -0,0 +1,45 @@ + + + +# toJson method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Map toJson() { + final Map data = {}; + data['_id'] = this.sId; + return data; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/LikedBy-class.md b/talawa-mobile-docs/models_post_post_model/LikedBy-class.md new file mode 100644 index 0000000000..414225f567 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/LikedBy-class.md @@ -0,0 +1,114 @@ + + + +# LikedBy class + + + + + + + + + +

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.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md b/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md new file mode 100644 index 0000000000..16f42a9a4e --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.fromJson.md @@ -0,0 +1,32 @@ + + + +# LikedBy.fromJson constructor + + + + + + + +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.

+ + + +## Implementation + +```dart +LikedBy.fromJson(Map json) { + sId = json['_id'] as String?; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md b/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md new file mode 100644 index 0000000000..81c5321ef0 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/LikedBy/LikedBy.md @@ -0,0 +1,29 @@ + + + +# LikedBy constructor + + + + + + + +LikedBy({[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId}) + + + + + +## Implementation + +```dart +LikedBy({this.sId}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md b/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md new file mode 100644 index 0000000000..ecdee05914 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/LikedBy/sId.md @@ -0,0 +1,37 @@ + + + +# sId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? sId + +_read / write_ + + + +

These are dart object.

+

params:

+
    +
  • sId : unique identifier for post
  • +
+ + + +## Implementation + +```dart +String? sId; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md b/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md new file mode 100644 index 0000000000..41171d83c7 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/LikedBy/toJson.md @@ -0,0 +1,45 @@ + + + +# toJson method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Map toJson() { + final Map data = {}; + data['_id'] = this.sId; + return data; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post-class.md b/talawa-mobile-docs/models_post_post_model/Post-class.md new file mode 100644 index 0000000000..aed8de17d3 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post-class.md @@ -0,0 +1,186 @@ + + + +# Post class + + + + + + + + + +

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.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 for post. +_read / write_ + + + +##### [createdAt](../models_post_post_model/Post/createdAt.md) ↔ [DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)? + + + +createdAt for post. +_read / write_ + + + +##### [creator](../models_post_post_model/Post/creator.md) ↔ [User](../models_user_user_info/User-class.md)? + + + +creator for post. +_read / write_ + + + +##### [description](../models_post_post_model/Post/description.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + +description for post. +_read / write_ + + + +##### [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_ + + + +##### [imageUrl](../models_post_post_model/Post/imageUrl.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + +imageUrl for post. +_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 for post. +_read / write_ + + + +##### [organization](../models_post_post_model/Post/organization.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? + + + +organization for post. +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [videoUrl](../models_post_post_model/Post/videoUrl.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + +videoUrl for post. +_read / write_ + + + + + +## Methods + +##### [getPostCreatedDuration](../models_post_post_model/Post/getPostCreatedDuration.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md b/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md new file mode 100644 index 0000000000..7dba822b4d --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/Post.fromJson.md @@ -0,0 +1,65 @@ + + + +# Post.fromJson constructor + + + + + + + +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: +None +returns:

+
    +
  • PostObject: Dart Object for posts
  • +
+ + + +## Implementation + +```dart +/// +/// 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) + : null; + organization = json['organization'] != null + ? 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)); + }); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/Post.md b/talawa-mobile-docs/models_post_post_model/Post/Post.md new file mode 100644 index 0000000000..829c0b018d --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/Post.md @@ -0,0 +1,39 @@ + + + +# Post constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +Post({ + required this.sId, + this.description, + this.createdAt, + this.imageUrl, + this.videoUrl, + required this.creator, + this.organization, + this.likedBy, + this.comments, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/comments.md b/talawa-mobile-docs/models_post_post_model/Post/comments.md new file mode 100644 index 0000000000..ecf3489660 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/comments.md @@ -0,0 +1,33 @@ + + + +# comments property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)>? comments + +_read / write_ + + + +

comments for post.

+ + + +## Implementation + +```dart +List? comments; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/createdAt.md b/talawa-mobile-docs/models_post_post_model/Post/createdAt.md new file mode 100644 index 0000000000..6238dfa3cf --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/createdAt.md @@ -0,0 +1,33 @@ + + + +# createdAt property + + + + + + + +[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html)? createdAt + +_read / write_ + + + +

createdAt for post.

+ + + +## Implementation + +```dart +DateTime? createdAt; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/creator.md b/talawa-mobile-docs/models_post_post_model/Post/creator.md new file mode 100644 index 0000000000..a7a0a80a41 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/creator.md @@ -0,0 +1,33 @@ + + + +# creator property + + + + + + + +[User](../../models_user_user_info/User-class.md)? creator + +_read / write_ + + + +

creator for post.

+ + + +## Implementation + +```dart +User? creator; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/description.md b/talawa-mobile-docs/models_post_post_model/Post/description.md new file mode 100644 index 0000000000..a34d1f7ab5 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/description.md @@ -0,0 +1,33 @@ + + + +# description property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description + +_read / write_ + + + +

description for post.

+ + + +## Implementation + +```dart +String? description; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md b/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md new file mode 100644 index 0000000000..561e425671 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/getPostCreatedDuration.md @@ -0,0 +1,55 @@ + + + +# getPostCreatedDuration method + + + + + + + + +[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.
  • +
+ + + +## 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'; + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md b/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md new file mode 100644 index 0000000000..ccbaf0864c --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/imageUrl.md @@ -0,0 +1,33 @@ + + + +# imageUrl property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl + +_read / write_ + + + +

imageUrl for post.

+ + + +## Implementation + +```dart +String? imageUrl; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/likedBy.md b/talawa-mobile-docs/models_post_post_model/Post/likedBy.md new file mode 100644 index 0000000000..3568e7dd84 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/likedBy.md @@ -0,0 +1,33 @@ + + + +# likedBy property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)>? likedBy + +_read / write_ + + + +

likedBy for post.

+ + + +## Implementation + +```dart +List? likedBy; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/organization.md b/talawa-mobile-docs/models_post_post_model/Post/organization.md new file mode 100644 index 0000000000..87e5b3d752 --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/organization.md @@ -0,0 +1,33 @@ + + + +# organization property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? organization + +_read / write_ + + + +

organization for post.

+ + + +## Implementation + +```dart +OrgInfo? organization; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/sId.md b/talawa-mobile-docs/models_post_post_model/Post/sId.md new file mode 100644 index 0000000000..1a82d26e6f --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/sId.md @@ -0,0 +1,33 @@ + + + +# sId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) sId + +_read / write_ + + + +

unique identifier for post.

+ + + +## Implementation + +```dart +late String sId; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md b/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md new file mode 100644 index 0000000000..12fb954e3e --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/Post/videoUrl.md @@ -0,0 +1,33 @@ + + + +# videoUrl property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? videoUrl + +_read / write_ + + + +

videoUrl for post.

+ + + +## Implementation + +```dart +String? videoUrl; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_post_post_model/models_post_post_model-library.md b/talawa-mobile-docs/models_post_post_model/models_post_post_model-library.md new file mode 100644 index 0000000000..6aa60a57af --- /dev/null +++ b/talawa-mobile-docs/models_post_post_model/models_post_post_model-library.md @@ -0,0 +1,52 @@ + + + + +# post_model library + + + + + + + + + + + +## Classes + +##### [Comments](../models_post_post_model/Comments-class.md) + + + +This class convert between json and object for comments. + + +##### [LikedBy](../models_post_post_model/LikedBy-class.md) + + + +This class convert between json and object for likedby. + + +##### [Post](../models_post_post_model/Post-class.md) + + + +This class creates a Post model. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task-class.md b/talawa-mobile-docs/models_task_task_model/Task-class.md new file mode 100644 index 0000000000..622477968d --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task-class.md @@ -0,0 +1,158 @@ + + + +# Task class + + + + + + + + + + + + + +## 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}) + + _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) + +/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) + + + + +_final_ + + + +##### [creator](../models_task_task_model/Task/creator.md) → [User](../models_user_user_info/User-class.md) + + + + +_final_ + + + +##### [deadline](../models_task_task_model/Task/deadline.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [description](../models_task_task_model/Task/description.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [event](../models_task_task_model/Task/event.md) → [Event](../models_events_event_model/Event-class.md) + + + + +_final_ + + + +##### [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_ + + + +##### [id](../models_task_task_model/Task/id.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [title](../models_task_task_model/Task/title.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md b/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md new file mode 100644 index 0000000000..f1c2c1fb00 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/Task.fromJson.md @@ -0,0 +1,47 @@ + + + +# Task.fromJson constructor + + + + + + + +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.

+ + + +## Implementation + +```dart +factory Task.fromJson( + Map json, +) { + return Task( + id: json['_id'] as String, + title: json['title'] as String, + creator: User.fromJson( + json['creator'] as Map, + fromOrg: true, + ), + event: Event.fromJson( + json['event'] as Map, + ), + createdAt: json['createdAt'] as String, + description: json['description'] as String?, + deadline: json['deadline'] as String?, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/Task.md b/talawa-mobile-docs/models_task_task_model/Task/Task.md new file mode 100644 index 0000000000..ee67ef19e9 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/Task.md @@ -0,0 +1,37 @@ + + + +# Task constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const Task({ + required this.id, + required this.title, + required this.creator, + required this.event, + required this.createdAt, + this.description, + this.deadline, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/createdAt.md b/talawa-mobile-docs/models_task_task_model/Task/createdAt.md new file mode 100644 index 0000000000..84314f52c8 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/createdAt.md @@ -0,0 +1,32 @@ + + + +# createdAt property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) createdAt + +_final_ + + + + + + +## Implementation + +```dart +final String createdAt; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/creator.md b/talawa-mobile-docs/models_task_task_model/Task/creator.md new file mode 100644 index 0000000000..b5c8e08369 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/creator.md @@ -0,0 +1,32 @@ + + + +# creator property + + + + + + + +[User](../../models_user_user_info/User-class.md) creator + +_final_ + + + + + + +## Implementation + +```dart +final User creator; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/deadline.md b/talawa-mobile-docs/models_task_task_model/Task/deadline.md new file mode 100644 index 0000000000..21dd7e7e7e --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/deadline.md @@ -0,0 +1,32 @@ + + + +# deadline property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? deadline + +_final_ + + + + + + +## Implementation + +```dart +final String? deadline; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/description.md b/talawa-mobile-docs/models_task_task_model/Task/description.md new file mode 100644 index 0000000000..ae3e97fef0 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/description.md @@ -0,0 +1,32 @@ + + + +# description property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? description + +_final_ + + + + + + +## Implementation + +```dart +final String? description; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/event.md b/talawa-mobile-docs/models_task_task_model/Task/event.md new file mode 100644 index 0000000000..9714bc41af --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/event.md @@ -0,0 +1,32 @@ + + + +# event property + + + + + + + +[Event](../../models_events_event_model/Event-class.md) event + +_final_ + + + + + + +## Implementation + +```dart +final Event event; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/id.md b/talawa-mobile-docs/models_task_task_model/Task/id.md new file mode 100644 index 0000000000..672a052c2a --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/id.md @@ -0,0 +1,32 @@ + + + +# id property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) id + +_final_ + + + + + + +## Implementation + +```dart +final String id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/Task/title.md b/talawa-mobile-docs/models_task_task_model/Task/title.md new file mode 100644 index 0000000000..7c14a38648 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/Task/title.md @@ -0,0 +1,32 @@ + + + +# title property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title + +_final_ + + + + + + +## Implementation + +```dart +final String title; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_task_task_model/models_task_task_model-library.md b/talawa-mobile-docs/models_task_task_model/models_task_task_model-library.md new file mode 100644 index 0000000000..3aed899654 --- /dev/null +++ b/talawa-mobile-docs/models_task_task_model/models_task_task_model-library.md @@ -0,0 +1,38 @@ + + + + +# task_model library + + + + + + + + + + + +## Classes + +##### [Task](../models_task_task_model/Task-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User-class.md b/talawa-mobile-docs/models_user_user_info/User-class.md new file mode 100644 index 0000000000..2f88321317 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User-class.md @@ -0,0 +1,311 @@ + + + +# User class + + + + + + + + + +

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) +- User + + + + + + +**Annotations** + +- @[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.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)>? + + + + +_read / write_ + + + +##### [authToken](../models_user_user_info/User/authToken.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_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)? + + + +Get the box in which this object is stored. Returns null if object has +not been added to a box yet. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [email](../models_user_user_info/User/email.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [firstName](../models_user_user_info/User/firstName.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [id](../models_user_user_info/User/id.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [image](../models_user_user_info/User/image.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_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) + + + +Returns whether this object is currently stored in a box. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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 +not been added to a box yet. +_read-onlyinherited_ + + + +##### [lastName](../models_user_user_info/User/lastName.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_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)>? + + + + +_read / write_ + + + +##### [refreshToken](../models_user_user_info/User/refreshToken.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + + + +## 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> + + + +Deletes this object from the box it is stored in. +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [print](../models_user_user_info/User/print.md)() 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_ + + + +##### [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_ + + + +##### [update](../models_user_user_info/User/update.md)([User](../models_user_user_info/User-class.md) details) 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 + + + + + + + + +##### [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 + + + + + + + + +##### [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 + + + + + + + + +##### [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 + + + + + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md b/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md new file mode 100644 index 0000000000..c568f69e4a --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/User.fromJson.md @@ -0,0 +1,71 @@ + + + +# User.fromJson constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +factory User.fromJson(Map json1, {bool fromOrg = false}) { + Map json; + if (fromOrg) { + json = json1; + } else { + json = json1['user'] as Map; + } + return User( + authToken: fromOrg ? ' ' : json1['accessToken'] as String?, + refreshToken: fromOrg ? ' ' : json1['refreshToken'] as String?, + id: json['_id'] as String?, + firstName: + json['firstName'] != null ? json['firstName'] as String? : null, + lastName: json['lastName'] != null ? json['lastName'] as String? : null, + 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)) + .toList() + : null, + createdOrganizations: json['createdOrganizations'] != null + ? (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)) + .toList() + : null, + membershipRequests: json['membershipRequests'] != null + ? (json['membershipRequests'] as List?) + ?.map( + (e) => OrgInfo.fromJson( + e as Map, + memberRequest: true, + ), + ) + .toList() + : null, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/User.md b/talawa-mobile-docs/models_user_user_info/User/User.md new file mode 100644 index 0000000000..2e34c1ed08 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/User.md @@ -0,0 +1,41 @@ + + + +# User constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +User({ + this.adminFor, + this.createdOrganizations, + this.email, + this.firstName, + this.id, + this.image, + this.joinedOrganizations, + this.lastName, + this.authToken, + this.refreshToken, + this.membershipRequests, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/adminFor.md b/talawa-mobile-docs/models_user_user_info/User/adminFor.md new file mode 100644 index 0000000000..f32ef5aca4 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/adminFor.md @@ -0,0 +1,36 @@ + + + +# adminFor property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(9) +List? adminFor = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/authToken.md b/talawa-mobile-docs/models_user_user_info/User/authToken.md new file mode 100644 index 0000000000..f378cbba33 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/authToken.md @@ -0,0 +1,36 @@ + + + +# authToken property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(0) +String? authToken; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md b/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md new file mode 100644 index 0000000000..791251b395 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/createdOrganizations.md @@ -0,0 +1,36 @@ + + + +# createdOrganizations property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(8) +List? createdOrganizations = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/email.md b/talawa-mobile-docs/models_user_user_info/User/email.md new file mode 100644 index 0000000000..34b599f1bc --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/email.md @@ -0,0 +1,36 @@ + + + +# email property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(5) +String? email; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/firstName.md b/talawa-mobile-docs/models_user_user_info/User/firstName.md new file mode 100644 index 0000000000..b782ee7afd --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/firstName.md @@ -0,0 +1,36 @@ + + + +# firstName property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(3) +String? firstName; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/id.md b/talawa-mobile-docs/models_user_user_info/User/id.md new file mode 100644 index 0000000000..1f2e418e57 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/id.md @@ -0,0 +1,36 @@ + + + +# id property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(2) +String? id; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/image.md b/talawa-mobile-docs/models_user_user_info/User/image.md new file mode 100644 index 0000000000..ff44e85e09 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/image.md @@ -0,0 +1,36 @@ + + + +# image property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(6) +String? image; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md b/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md new file mode 100644 index 0000000000..364ee575b9 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/joinedOrganizations.md @@ -0,0 +1,36 @@ + + + +# joinedOrganizations property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(7) +List? joinedOrganizations = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/lastName.md b/talawa-mobile-docs/models_user_user_info/User/lastName.md new file mode 100644 index 0000000000..b02f4c180f --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/lastName.md @@ -0,0 +1,36 @@ + + + +# lastName property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(4) +String? lastName; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md b/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md new file mode 100644 index 0000000000..483f6a9dff --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/membershipRequests.md @@ -0,0 +1,36 @@ + + + +# membershipRequests property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(10) +List? membershipRequests = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/print.md b/talawa-mobile-docs/models_user_user_info/User/print.md new file mode 100644 index 0000000000..9887d704aa --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/print.md @@ -0,0 +1,46 @@ + + + +# print method + + + + + + + + +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}'); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/refreshToken.md b/talawa-mobile-docs/models_user_user_info/User/refreshToken.md new file mode 100644 index 0000000000..87c25db04f --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/refreshToken.md @@ -0,0 +1,36 @@ + + + +# refreshToken property + + + + + + + +**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 + +_read / write_ + + + + + + +## Implementation + +```dart +@HiveField(1) +String? refreshToken; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/update.md b/talawa-mobile-docs/models_user_user_info/User/update.md new file mode 100644 index 0000000000..a11d0f0234 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/update.md @@ -0,0 +1,45 @@ + + + +# update method + + + + + + + + +void update +([User](../../models_user_user_info/User-class.md) details) + + + + + + + + +## Implementation + +```dart +void update(User details) { + this.firstName = details.firstName; + this.lastName = details.lastName; + this.email = details.email; + this.image = details.image; + this.authToken = details.authToken; + this.refreshToken = details.refreshToken; + this.joinedOrganizations = details.joinedOrganizations; + this.createdOrganizations = details.createdOrganizations; + this.membershipRequests = details.membershipRequests; + this.adminFor = details.adminFor; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md b/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md new file mode 100644 index 0000000000..0d104cd528 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/updateAdminFor.md @@ -0,0 +1,36 @@ + + + +# updateAdminFor method + + + + + + + + +void updateAdminFor +([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) + + + + + + + + +## Implementation + +```dart +void updateAdminFor(List orgList) { + this.adminFor = orgList; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md b/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md new file mode 100644 index 0000000000..384f2a3638 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/updateCreatedOrg.md @@ -0,0 +1,36 @@ + + + +# updateCreatedOrg method + + + + + + + + +void updateCreatedOrg +([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) + + + + + + + + +## Implementation + +```dart +void updateCreatedOrg(List orgList) { + this.createdOrganizations = orgList; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md b/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md new file mode 100644 index 0000000000..ce7eb1d641 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/updateJoinedOrg.md @@ -0,0 +1,36 @@ + + + +# updateJoinedOrg method + + + + + + + + +void updateJoinedOrg +([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) + + + + + + + + +## Implementation + +```dart +void updateJoinedOrg(List orgList) { + this.joinedOrganizations = orgList; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md b/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md new file mode 100644 index 0000000000..a64ede2dca --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/User/updateMemberRequestOrg.md @@ -0,0 +1,36 @@ + + + +# updateMemberRequestOrg method + + + + + + + + +void updateMemberRequestOrg +([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> orgList) + + + + + + + + +## Implementation + +```dart +void updateMemberRequestOrg(List orgList) { + this.membershipRequests = [...membershipRequests!, ...orgList]; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md b/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md new file mode 100644 index 0000000000..128bc0ea40 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter-class.md @@ -0,0 +1,130 @@ + + + +# UserAdapter class + + + + + + + + + + + + +**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)> +- UserAdapter + + + + + + + + +## Constructors + +[UserAdapter](../models_user_user_info/UserAdapter/UserAdapter.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [typeId](../models_user_user_info/UserAdapter/typeId.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + +Called for type registration +_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 + + + +Invoked when a non-existent method or property is accessed. +_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) + + + +Is called when a value has to be decoded. +_override_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_override_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter/UserAdapter.md b/talawa-mobile-docs/models_user_user_info/UserAdapter/UserAdapter.md new file mode 100644 index 0000000000..cd7b0178d6 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter/UserAdapter.md @@ -0,0 +1,24 @@ + + + +# UserAdapter constructor + + + + + + + +UserAdapter() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md b/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md new file mode 100644 index 0000000000..8cc0476945 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter/hashCode.md @@ -0,0 +1,65 @@ + + + +# hashCode property + + + + + + + + + +**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_ + + + +

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 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 ==. +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. +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.

+ + + +## Implementation + +```dart +@override +int get hashCode => typeId.hashCode; +``` + + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter/operator_equals.md b/talawa-mobile-docs/models_user_user_info/UserAdapter/operator_equals.md new file mode 100644 index 0000000000..2138164e9b --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter/operator_equals.md @@ -0,0 +1,67 @@ + + + +# operator == method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) operator == +([Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) other) + +_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 +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, +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.

+ + + +## Implementation + +```dart +@override +bool operator ==(Object other) => + identical(this, other) || + other is UserAdapter && + runtimeType == other.runtimeType && + typeId == other.typeId; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md b/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md new file mode 100644 index 0000000000..8431b02dd5 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter/read.md @@ -0,0 +1,55 @@ + + + +# read method + + + + + + + +- @[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) + +_override_ + + + +

Is called when a value has to be decoded.

+ + + +## Implementation + +```dart +@override +User read(BinaryReader reader) { + final numOfFields = reader.readByte(); + 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(), + 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(), + lastName: fields[4] as String?, + authToken: fields[0] as String?, + refreshToken: fields[1] as String?, + membershipRequests: (fields[10] as List?)?.cast(), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md b/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md new file mode 100644 index 0000000000..2fc04cff05 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter/typeId.md @@ -0,0 +1,37 @@ + + + +# typeId property + + + + + + + +**Annotations** + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) typeId + +_final_ + + + +

Called for type registration

+ + + +## Implementation + +```dart +@override +final int typeId = 1; +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md b/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md new file mode 100644 index 0000000000..5d2fbb7a79 --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/UserAdapter/write.md @@ -0,0 +1,62 @@ + + + +# write method + + + + + + + +- @[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) + +_override_ + + + +

Is called when a value has to be encoded.

+ + + +## Implementation + +```dart +@override +void write(BinaryWriter writer, User obj) { + writer + ..writeByte(11) + ..writeByte(0) + ..write(obj.authToken) + ..writeByte(1) + ..write(obj.refreshToken) + ..writeByte(2) + ..write(obj.id) + ..writeByte(3) + ..write(obj.firstName) + ..writeByte(4) + ..write(obj.lastName) + ..writeByte(5) + ..write(obj.email) + ..writeByte(6) + ..write(obj.image) + ..writeByte(7) + ..write(obj.joinedOrganizations) + ..writeByte(8) + ..write(obj.createdOrganizations) + ..writeByte(9) + ..write(obj.adminFor) + ..writeByte(10) + ..write(obj.membershipRequests); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/models_user_user_info/models_user_user_info-library.md b/talawa-mobile-docs/models_user_user_info/models_user_user_info-library.md new file mode 100644 index 0000000000..2f7570090c --- /dev/null +++ b/talawa-mobile-docs/models_user_user_info/models_user_user_info-library.md @@ -0,0 +1,45 @@ + + + + +# user_info library + + + + + + + + + + + +## Classes + +##### [User](../models_user_user_info/User-class.md) + + + +This class creates a User model and returns a user instance. + + +##### [UserAdapter](../models_user_user_info/UserAdapter-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md new file mode 100644 index 0000000000..84893bd0b0 --- /dev/null +++ b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList-class.md @@ -0,0 +1,110 @@ + + + +# FetchPluginList class + + + + + + + + + +

This class fetch plugins list.

+ + + + +## Constructors + +[FetchPluginList](../plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md) () + +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) + + + +late initialize the box. +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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. + + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md new file mode 100644 index 0000000000..55304e7c1f --- /dev/null +++ b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/FetchPluginList.md @@ -0,0 +1,32 @@ + + + +# FetchPluginList constructor + + + + + + + +FetchPluginList() + + +

Constructor of the class.

+ + + +## Implementation + +```dart +FetchPluginList() { + fetchList(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md new file mode 100644 index 0000000000..a402769669 --- /dev/null +++ b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/box.md @@ -0,0 +1,33 @@ + + + +# box property + + + + + + + +[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html) box + +_read / write_ + + + +

late initialize the box.

+ + + +## Implementation + +```dart +late Box box; +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md new file mode 100644 index 0000000000..4a819919aa --- /dev/null +++ b/talawa-mobile-docs/plugins_fetch_plugin_list/FetchPluginList/fetchList.md @@ -0,0 +1,50 @@ + + + +# fetchList method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future fetchList() async { + late final GraphQLClient client = graphqlConfig.clientToQuery(); + final QueryResult result = await client.query( + QueryOptions( + document: gql(queries.getPluginsList()), + ), + ); + box = Hive.box('pluginBox'); + box.put('plugins', result.data!["getPlugins"]); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_fetch_plugin_list/plugins_fetch_plugin_list-library.md b/talawa-mobile-docs/plugins_fetch_plugin_list/plugins_fetch_plugin_list-library.md new file mode 100644 index 0000000000..a2d80f3b5b --- /dev/null +++ b/talawa-mobile-docs/plugins_fetch_plugin_list/plugins_fetch_plugin_list-library.md @@ -0,0 +1,38 @@ + + + + +# fetch_plugin_list library + + + + + + + + + + + +## Classes + +##### [FetchPluginList](../plugins_fetch_plugin_list/FetchPluginList-class.md) + + + +This class fetch plugins list. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md new file mode 100644 index 0000000000..85a8d898a1 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider-class.md @@ -0,0 +1,225 @@ + + + +# TalawaPluginProvider class + + + + + + + + + +

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) +- TalawaPluginProvider + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 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) + + + +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) + + + +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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md new file mode 100644 index 0000000000..fc8bbf2802 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/TalawaPluginProvider.md @@ -0,0 +1,34 @@ + + + +# TalawaPluginProvider constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const TalawaPluginProvider({ + Key? key, + @required this.child, + required this.visible, + required this.pluginName, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md new file mode 100644 index 0000000000..1c71ed24b2 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/build.md @@ -0,0 +1,41 @@ + + + +# build method + + + + + + + +- @[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) + +_override_ + + + +

build the Plugin combining local visibility property and serverVisible property

+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + var serverVisible = false; + serverVisible = checkFromPluginList(); + return serverVisible || visible ? child! : Container(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md new file mode 100644 index 0000000000..b432bce740 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/checkFromPluginList.md @@ -0,0 +1,60 @@ + + + +# checkFromPluginList method + + + + + + + + +[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

+ + + +## Implementation + +```dart +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 [] + + ///mapping over the list from the server + pluginList + .map( + (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/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md new file mode 100644 index 0000000000..35ec65b913 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/child.md @@ -0,0 +1,33 @@ + + + +# child property + + + + + + + +[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html)? child + +_final_ + + + +

child contains the widget for the plugin UI.

+ + + +## Implementation + +```dart +final Widget? child; +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md new file mode 100644 index 0000000000..9825d89330 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/pluginName.md @@ -0,0 +1,33 @@ + + + +# pluginName property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) pluginName + +_final_ + + + +

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

+ + + +## Implementation + +```dart +final String pluginName; +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md new file mode 100644 index 0000000000..bacba07b8f --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/TalawaPluginProvider/visible.md @@ -0,0 +1,33 @@ + + + +# visible property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) visible + +_final_ + + + +

visible is the property that decides visibility of the UI.

+ + + +## Implementation + +```dart +final bool visible; +``` + + + + + + + diff --git a/talawa-mobile-docs/plugins_talawa_plugin_provider/plugins_talawa_plugin_provider-library.md b/talawa-mobile-docs/plugins_talawa_plugin_provider/plugins_talawa_plugin_provider-library.md new file mode 100644 index 0000000000..e6d50cae72 --- /dev/null +++ b/talawa-mobile-docs/plugins_talawa_plugin_provider/plugins_talawa_plugin_provider-library.md @@ -0,0 +1,38 @@ + + + + +# talawa_plugin_provider library + + + + + + + + + + + +## Classes + +##### [TalawaPluginProvider](../plugins_talawa_plugin_provider/TalawaPluginProvider-class.md) + + + +TalwaPluginProvider provides ability to implement features as plugins + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/router/generateRoute.md b/talawa-mobile-docs/router/generateRoute.md new file mode 100644 index 0000000000..cdb9d89fbd --- /dev/null +++ b/talawa-mobile-docs/router/generateRoute.md @@ -0,0 +1,294 @@ + + + +# generateRoute function + + + + + + + + + + +[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

+ + + +## 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 + case Routes.splashScreen: + final int mainScreenIndex = settings.arguments! as int; + return MaterialPageRoute( + builder: (context) => SplashScreen( + key: const Key('SplashScreen'), + mainScreenIndex: mainScreenIndex, + ), + ); + + // Returns the SelectLanguage Widget + case Routes.languageSelectionRoute: + return MaterialPageRoute( + builder: (context) => const SelectLanguage(key: Key('SelectLanguage')), + ); + + // Returns the SetUrl Widget + case Routes.setUrlScreen: + final String uri = settings.arguments!.toString(); + return MaterialPageRoute( + builder: (context) => SetUrl( + key: const Key('SetUrl'), + uri: uri, + ), + ); + + // Returns the Login Widget + case Routes.loginScreen: + return MaterialPageRoute( + builder: (context) => const Login(key: Key('Login')), + ); + + // Returns the SelectOrganization Widget + case Routes.selectOrgScreen: + final String id = settings.arguments!.toString(); + return CupertinoPageRoute( + builder: (context) => SelectOrganization( + key: const Key('Signup'), + selectedOrgId: id, + ), + ); + + // Returns the SignUpDetails Widget + case Routes.signupDetailScreen: + final OrgInfo org = settings.arguments! as OrgInfo; + return CupertinoPageRoute( + builder: (context) => SignUpDetails( + key: const Key('Signup'), + selectedOrg: org, + ), + ); + + // Returns the WaitingPge Widget + case Routes.waitingScreen: + return CupertinoPageRoute( + builder: (context) => const WaitingPage(key: Key('Waiting')), + ); + + // Returns the Recover Widget + case Routes.recoverScreen: + return MaterialPageRoute( + builder: (context) => const Recover(key: Key('Recover')), + ); + + // Returns the ChangePass Widget + case Routes.updateScreen: + return MaterialPageRoute( + builder: (context) => const ChangePass(key: Key('Update')), + ); + + // Returns the OrganizationFeed Widget + case Routes.homeScreen: + return MaterialPageRoute( + builder: (context) => const OrganizationFeed(key: Key('HomeScreen')), + ); + + // Returns the MainScreen Widget + case Routes.mainScreen: + final MainScreenArgs mainScreenArgs = + settings.arguments! as MainScreenArgs; + // final bool fromSignUp = settings.arguments! as bool; + return MaterialPageRoute( + builder: (context) => MainScreen( + key: const Key('MainScreen'), + mainScreenArgs: mainScreenArgs, + ), + ); + + // Returns the IndividualPostView Widget + case Routes.individualPost: + final Post post = settings.arguments! as Post; + return MaterialPageRoute( + builder: (context) => IndividualPostView( + key: const Key('IndividualPost'), + post: post, + ), + ); + + // Returns the PinnedPostPgae Widget + case Routes.pinnedPostPage: + final List pinnedPosts = settings.arguments! as List; + return MaterialPageRoute( + builder: (context) => PinnedPostPage(pinnedPosts: pinnedPosts), + ); + + // Returns the ExploreEvents Widget + case Routes.exploreEventsScreen: + return MaterialPageRoute( + builder: (context) => const ExploreEvents(key: Key('ExploreEvents')), + ); + + // Returns the EventInfoPage Widget + case Routes.eventInfoPage: + final Map args = + settings.arguments! as Map; + return MaterialPageRoute( + builder: (context) => EventInfoPage( + key: const Key('EventInfo'), + args: args, + ), + ); + + // Returns the CreateEventPage Widget + case Routes.createEventPage: + return MaterialPageRoute( + builder: (context) => const CreateEventPage(key: Key('CreateEvent')), + ); + + // Returns the ProfilePage Widget + case Routes.profilePage: + return MaterialPageRoute( + builder: (context) => const ProfilePage(key: Key('Profile')), + ); + + // Returns the EditProfilePage Widget + case Routes.editProfilePage: + return MaterialPageRoute( + builder: (context) => const EditProfilePage(key: Key('EditProfile')), + ); + + // Returns the JoinOrganizationAfterAuth Widget + case Routes.joinOrg: + final String id = settings.arguments!.toString(); + return MaterialPageRoute( + builder: (context) => JoinOrganisationAfterAuth( + key: const Key('JoinOrganisationAfterAuth'), + orgId: id, + ), + ); + + case Routes.requestAccess: + final OrgInfo org = settings.arguments! as OrgInfo; + return CupertinoPageRoute( + builder: (context) => SendAccessRequest( + key: const Key('Signup'), + org: org, + ), + ); + // Returns the EditEventPage Widget + case Routes.editEventPage: + final Event event = settings.arguments! as Event; + return MaterialPageRoute( + builder: (context) => EditEventPage( + key: const Key('EditEvent'), + event: event, + ), + ); + + // Returns the AppSettingsPage Widget + case Routes.appSettings: + return MaterialPageRoute( + builder: (context) => const AppSettingsPage(key: Key('AppSettings')), + ); + + // Returns the ChatMessageScreen Widget + case Routes.chatMessageScreen: + 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( + key: const Key('ChatMessageScreen'), + chatId: chatId, + model: model, + ), + ); + + // Returns the MapScreen Widget + case Routes.mapScreen: + 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( + model, + latitude, + longitude, + key: const Key('MapScreen'), + ), + ); + case Routes.calendar: + return MaterialPageRoute( + 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( + eventId: eventId, + key: const Key('EventTasks'), + ), + ); + case Routes.userTasks: + return MaterialPageRoute( + builder: (context) => const UserTasksPage( + key: Key('UserTasks'), + ), + ); + case Routes.addTask: + final eventId = settings.arguments! as String; + return MaterialPageRoute( + builder: (context) => CreateTaskPage( + key: const Key('AddTask'), + eventId: eventId, + ), + ); + case Routes.editTask: + final task = settings.arguments! as Task; + return MaterialPageRoute( + builder: (context) => EditTaskPage( + key: const Key('EditTask'), + task: task, + ), + ); + // Returns the DemoPageView Widget by default + case Routes.selectContact: + return MaterialPageRoute( + builder: (context) => const SelectContact(key: Key('selectContact')), + ); + default: + return MaterialPageRoute( + builder: (context) => const DemoPageView( + key: Key("DemoPage"), + ), + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/router/router-library.md b/talawa-mobile-docs/router/router-library.md new file mode 100644 index 0000000000..c8ba8c929a --- /dev/null +++ b/talawa-mobile-docs/router/router-library.md @@ -0,0 +1,41 @@ + + + + +# router library + + + + + + + + + + + + + + + + +## 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) + + + +The MaterialApp provides us with a property called generateRoute where +we can pass in a Function that returns a Route and takes in RouteSettings + + + + + + + + + + + + diff --git a/talawa-mobile-docs/search.md b/talawa-mobile-docs/search.md new file mode 100644 index 0000000000..0fedbdcfdd --- /dev/null +++ b/talawa-mobile-docs/search.md @@ -0,0 +1,6 @@ +# 404 + +Oops, something's gone wrong :-( + +You've tried to visit a page that doesn't exist. Luckily this site has other +[pages](index.md). diff --git a/talawa-mobile-docs/services_chat_service/ChatService-class.md b/talawa-mobile-docs/services_chat_service/ChatService-class.md new file mode 100644 index 0000000000..1139306407 --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService-class.md @@ -0,0 +1,152 @@ + + + +# ChatService class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[ChatService](../services_chat_service/ChatService/ChatService.md) () + + + + +## 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)> + + + + +_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)> + + + + +_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)?>> + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [getDirectChatMessagesByChatId](../services_chat_service/ChatService/getDirectChatMessagesByChatId.md)(dynamic chatId) [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + +This function is used to get all the chat messages of a particular chat by the user. + + + + +##### [getDirectChatsByUserId](../services_chat_service/ChatService/getDirectChatsByUserId.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md b/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md new file mode 100644 index 0000000000..3dfdea61a5 --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/ChatService.md @@ -0,0 +1,33 @@ + + + +# ChatService constructor + + + + + + + +ChatService() + + + + + +## Implementation + +```dart +ChatService() { + _dbFunctions = locator(); + _chatListStream = _chatController.stream.asBroadcastStream(); + _chatMessagesStream = _chatMessageController.stream.asBroadcastStream(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md b/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md new file mode 100644 index 0000000000..2f7d5759ec --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/chatListStream.md @@ -0,0 +1,35 @@ + + + +# chatListStream property + + + + + + + + + +[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)> chatListStream + + + + + + + + +## Implementation + +```dart +Stream get chatListStream => _chatListStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md b/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md new file mode 100644 index 0000000000..740897507a --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/chatMessagesStream.md @@ -0,0 +1,35 @@ + + + +# chatMessagesStream property + + + + + + + + + +[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[ChatMessage](../../models_chats_chat_message/ChatMessage-class.md)> chatMessagesStream + + + + + + + + +## Implementation + +```dart +Stream get chatMessagesStream => _chatMessagesStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md b/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md new file mode 100644 index 0000000000..be41fbc55c --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/chatStream.md @@ -0,0 +1,32 @@ + + + +# chatStream property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +late Stream chatStream; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md b/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md new file mode 100644 index 0000000000..bf6686a9cd --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatMessagesByChatId.md @@ -0,0 +1,52 @@ + + + +# getDirectChatMessagesByChatId method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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); + + final result = await _dbFunctions.gqlAuthQuery(query); + + final messages = result.data['directChatsMessagesByChatID'] as List; + + messages.forEach((message) { + final chatMessage = ChatMessage.fromJson(message as Map); + _chatMessageController.add(chatMessage); + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md b/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md new file mode 100644 index 0000000000..0ae91a2aea --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/getDirectChatsByUserId.md @@ -0,0 +1,58 @@ + + + +# getDirectChatsByUserId method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future getDirectChatsByUserId() async { + final userId = _userConfig.currentUser.id; + + // 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) { + final directChat = + ChatListTileDataModel.fromJson(chat as Map); + + directChat.users!.forEach((element) { + if (element.id != userId) _chatController.add(directChat); + }); + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md b/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md new file mode 100644 index 0000000000..903348164f --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/ChatService/sendMessageToDirectChat.md @@ -0,0 +1,57 @@ + + + +# sendMessageToDirectChat method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future sendMessageToDirectChat( + String chatId, + String messageContent, +) async { + // trigger graphQL mutation to push the message in the Database. + final result = await _dbFunctions.gqlAuthMutation( + ChatQueries().sendMessageToDirectChat(), + variables: {"chatId": chatId, "messageContent": messageContent}, + ); + + final message = ChatMessage.fromJson( + result.data['sendMessageToDirectChat'] as Map, + ); + + _chatMessageController.add(message); + + debugPrint(result.data.toString()); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_chat_service/services_chat_service-library.md b/talawa-mobile-docs/services_chat_service/services_chat_service-library.md new file mode 100644 index 0000000000..a59fdbcae7 --- /dev/null +++ b/talawa-mobile-docs/services_chat_service/services_chat_service-library.md @@ -0,0 +1,38 @@ + + + + +# chat_service library + + + + + + + + + + + +## Classes + +##### [ChatService](../services_chat_service/ChatService-class.md) + + + +ChatService class provides different services for direct chats of the user. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_comment_service/CommentService-class.md b/talawa-mobile-docs/services_comment_service/CommentService-class.md new file mode 100644 index 0000000000..b3599d7f73 --- /dev/null +++ b/talawa-mobile-docs/services_comment_service/CommentService-class.md @@ -0,0 +1,115 @@ + + + +# CommentService class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[CommentService](../services_comment_service/CommentService/CommentService.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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> + + + +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) + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md b/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md new file mode 100644 index 0000000000..c59a7cc7e1 --- /dev/null +++ b/talawa-mobile-docs/services_comment_service/CommentService/CommentService.md @@ -0,0 +1,31 @@ + + + +# CommentService constructor + + + + + + + +CommentService() + + + + + +## Implementation + +```dart +CommentService() { + _dbFunctions = locator(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_comment_service/CommentService/createComments.md b/talawa-mobile-docs/services_comment_service/CommentService/createComments.md new file mode 100644 index 0000000000..741c7348c4 --- /dev/null +++ b/talawa-mobile-docs/services_comment_service/CommentService/createComments.md @@ -0,0 +1,53 @@ + + + +# createComments method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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 + 'text': text + }, + ); + print("comment added"); + print(result); + return result; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md b/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md new file mode 100644 index 0000000000..956c67208c --- /dev/null +++ b/talawa-mobile-docs/services_comment_service/CommentService/getCommentsForPost.md @@ -0,0 +1,46 @@ + + + +# getCommentsForPost method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future getCommentsForPost(String postId) async { + final String getCommmentQuery = CommentQueries().getPostsComments(postId); + final result = await _dbFunctions.gqlAuthMutation(getCommmentQuery); + if (result.data != null) { + return result.data["commentsByPost"] as List; + } + return []; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_comment_service/services_comment_service-library.md b/talawa-mobile-docs/services_comment_service/services_comment_service-library.md new file mode 100644 index 0000000000..3926830456 --- /dev/null +++ b/talawa-mobile-docs/services_comment_service/services_comment_service-library.md @@ -0,0 +1,38 @@ + + + + +# comment_service library + + + + + + + + + + + +## Classes + +##### [CommentService](../services_comment_service/CommentService-class.md) + + + +CommentService class have different member functions which provides service in the context of commenting. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md new file mode 100644 index 0000000000..90c047dce8 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions-class.md @@ -0,0 +1,264 @@ + + + +# DataBaseMutationFunctions class + + + + + + + + + +

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

+

Services include:

+
    +
  • encounteredExceptionOrError
  • +
  • gqlAuthQuery
  • +
  • gqlAuthMutation
  • +
  • gqlNonAuthMutation
  • +
  • gqlNonAuthQuery
  • +
  • refreshAccessToken
  • +
  • fetchOrgById
  • +
+ + + + +## Constructors + +[DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions/DataBaseMutationFunctions.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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)? + + + +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) + + + +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) + + + +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) + + + +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) + + + +This function is used to run the graph-ql mutation to authenticate the non signed-in user. + + + + +##### [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)?>?> + + + +This function is used to run the graph-ql query for the non signed-in user. + + + + +##### [init](../services_database_mutation_functions/DataBaseMutationFunctions/init.md)() void + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_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)> + + + +This function is used to refresh the Authenication token to access the application. + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/DataBaseMutationFunctions.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/DataBaseMutationFunctions.md new file mode 100644 index 0000000000..cd5b61c646 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/DataBaseMutationFunctions.md @@ -0,0 +1,24 @@ + + + +# DataBaseMutationFunctions constructor + + + + + + + +DataBaseMutationFunctions() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md new file mode 100644 index 0000000000..4c673497f0 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientAuth.md @@ -0,0 +1,33 @@ + + + +# clientAuth property + + + + + + + +[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientAuth + +_read / write_ + + + +

Client Auth for handling authenticated request.

+ + + +## Implementation + +```dart +late GraphQLClient clientAuth; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md new file mode 100644 index 0000000000..4b73d5782f --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/clientNonAuth.md @@ -0,0 +1,33 @@ + + + +# clientNonAuth property + + + + + + + +[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientNonAuth + +_read / write_ + + + +

Client Auth for handling non-authenticated request.

+ + + +## Implementation + +```dart +late GraphQLClient clientNonAuth; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md new file mode 100644 index 0000000000..62e143ed20 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/emailAccountPresent.md @@ -0,0 +1,34 @@ + + + +# emailAccountPresent property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) emailAccountPresent + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError emailAccountPresent = + const GraphQLError(message: 'Email address already exists'); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md new file mode 100644 index 0000000000..f08740a42b --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/encounteredExceptionOrError.md @@ -0,0 +1,175 @@ + + + +# encounteredExceptionOrError method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +bool? encounteredExceptionOrError( + OperationException exception, { + bool showSnackBar = true, +}) { + // if server link is wrong. + if (exception.linkException != null) { + // debugPrint(exception.linkException.toString()); + if (showSnackBar) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => navigationService.showTalawaErrorSnackBar( + "Server not running/wrong url", + MessageType.info, + ), + ); + } + return false; + } + + /// 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" + if (exception.graphqlErrors[i].message == + refreshAccessTokenExpiredException.message) { + print('token refreshed'); + refreshAccessToken(userConfig.currentUser.refreshToken!).then( + (value) => graphqlConfig + .getToken() + .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) { + print('client refreshed'); + refreshAccessToken(userConfig.currentUser.refreshToken!).then( + (value) => graphqlConfig + .getToken() + .then((value) => databaseFunctions.init()), + ); + return true; + } + + /// if the error message is "User not found" + if (exception.graphqlErrors[i].message == userNotFound.message) { + if (showSnackBar) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => 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) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => 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) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => 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) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => 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) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => navigationService.showTalawaErrorDialog( + "Account with this email already registered", + MessageType.error, + ), + ); + } + return false; + } + if (exception.graphqlErrors[i].message == + notifFeatureNotInstalled.message) { + if (showSnackBar) { + WidgetsBinding.instance.addPostFrameCallback( + (_) => navigationService.showTalawaErrorDialog( + "Notification Feature is not installed", + MessageType.error, + ), + ); + } + return false; + } + } + // if the error is unknown + + WidgetsBinding.instance.addPostFrameCallback( + (_) => navigationService.showTalawaErrorDialog( + "Something went wrong!", + MessageType.error, + ), + ); + return false; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md new file mode 100644 index 0000000000..8fb60f8195 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/fetchOrgById.md @@ -0,0 +1,60 @@ + + + +# fetchOrgById method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +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) { + final exception = encounteredExceptionOrError(result.exception!); + if (exception!) { + fetchOrgById(id); + } + } else if (result.data != null && result.isConcrete) { + return OrgInfo.fromJson( + // ignore: collection_methods_unrelated_type + (result.data!['organizations'] as Map)[0] + as Map, + ); + } + return false; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md new file mode 100644 index 0000000000..ea11a8fe95 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthMutation.md @@ -0,0 +1,64 @@ + + + +# gqlAuthMutation method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future gqlAuthMutation( + String mutation, { + Map? variables, +}) async { + final QueryResult result = await clientAuth.mutate( + MutationOptions( + document: gql(mutation), + variables: variables ?? {}, + ), + ); + // if there is an error or exception in [result] + if (result.hasException) { + final exception = encounteredExceptionOrError(result.exception!); + if (exception!) { + gqlAuthMutation(mutation, variables: variables); + } + } else if (result.data != null && result.isConcrete) { + return result; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md new file mode 100644 index 0000000000..a90ff7cf53 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlAuthQuery.md @@ -0,0 +1,63 @@ + + + +# gqlAuthQuery method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future gqlAuthQuery( + String query, { + Map? variables, +}) async { + final QueryOptions options = QueryOptions( + document: gql(query), + variables: variables ?? {}, + ); + final QueryResult result = await clientAuth.query(options); + // if there is an error or exception in [result] + if (result.hasException) { + final exception = encounteredExceptionOrError(result.exception!); + if (exception!) { + gqlAuthQuery(query, variables: variables); + } + } else if (result.data != null && result.isConcrete) { + return result; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md new file mode 100644 index 0000000000..8791e72a23 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthMutation.md @@ -0,0 +1,66 @@ + + + +# gqlNonAuthMutation method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future gqlNonAuthMutation( + String mutation, { + Map? variables, + bool reCall = true, +}) async { + final QueryResult result = await clientNonAuth.mutate( + MutationOptions( + document: gql(mutation), + variables: variables ?? {}, + ), + ); + // if there is an error or exception in [result] + if (result.hasException) { + final exception = encounteredExceptionOrError(result.exception!); + if (exception! && reCall) { + gqlNonAuthMutation(mutation, variables: variables); + } + } else if (result.data != null && result.isConcrete) { + return result; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md new file mode 100644 index 0000000000..6f2ac2bdf4 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/gqlNonAuthQuery.md @@ -0,0 +1,64 @@ + + + +# gqlNonAuthQuery method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future?> gqlNonAuthQuery( + String query, { + Map? variables, +}) async { + final queryOptions = QueryOptions( + document: gql(query), + variables: variables ?? {}, + ); + final result = await clientNonAuth.query(queryOptions); + QueryResult? finalRes; + // if there is an error or exception in [result] + if (result.hasException) { + final exception = encounteredExceptionOrError(result.exception!); + if (exception!) { + finalRes = await gqlNonAuthQuery(query, variables: variables); + } + } else if (result.data != null && result.isConcrete) { + return result; + } + return finalRes; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md new file mode 100644 index 0000000000..c31b1aeb83 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/init.md @@ -0,0 +1,43 @@ + + + +# init method + + + + + + + + +void init +() + + + + + +

initialization function.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void init() { + clientNonAuth = graphqlConfig.clientToQuery(); + clientAuth = graphqlConfig.authClient(); + _query = Queries(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md new file mode 100644 index 0000000000..ec1aaa4f9a --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/memberRequestExist.md @@ -0,0 +1,34 @@ + + + +# memberRequestExist property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) memberRequestExist + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError memberRequestExist = + const GraphQLError(message: 'Membership Request already exists'); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md new file mode 100644 index 0000000000..3047b0b223 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/notifFeatureNotInstalled.md @@ -0,0 +1,36 @@ + + + +# notifFeatureNotInstalled property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) notifFeatureNotInstalled + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError notifFeatureNotInstalled = const GraphQLError( + message: + 'Failed to determine project ID: Error while making request: getaddrinfo ENOTFOUND metadata.google.internal. Error code: ENOTFOUND', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md new file mode 100644 index 0000000000..14aac023bf --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/organizationNotFound.md @@ -0,0 +1,34 @@ + + + +# organizationNotFound property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) organizationNotFound + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError organizationNotFound = + const GraphQLError(message: 'Organization not found'); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md new file mode 100644 index 0000000000..b89af5e646 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessToken.md @@ -0,0 +1,73 @@ + + + +# refreshAccessToken method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future refreshAccessToken(String refreshToken) async { + // run the graphQL mutation + final QueryResult result = await clientNonAuth.mutate( + MutationOptions( + document: gql( + _query.refreshToken(refreshToken), + ), + ), + ); + // if there is an error or exception in [result] + if (result.hasException) { + final exception = encounteredExceptionOrError(result.exception!); + if (exception!) { + refreshAccessToken(refreshToken); + } else { + navigationService.pop(); + } + } else if (result.data != null && result.isConcrete) { + userConfig.updateAccessToken( + refreshToken: (result.data!['refreshToken'] + as Map)['refreshToken'] + .toString(), + accessToken: (result.data!['refreshToken'] + as Map)['accessToken'] + .toString(), + ); + databaseFunctions.init(); + return true; + } + return false; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md new file mode 100644 index 0000000000..6a21805485 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/refreshAccessTokenExpiredException.md @@ -0,0 +1,36 @@ + + + +# refreshAccessTokenExpiredException property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) refreshAccessTokenExpiredException + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError refreshAccessTokenExpiredException = const GraphQLError( + message: + 'Access Token has expired. Please refresh session.: Undefined location', +); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md new file mode 100644 index 0000000000..a812e0ddc0 --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotAuthenticated.md @@ -0,0 +1,34 @@ + + + +# userNotAuthenticated property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) userNotAuthenticated + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError userNotAuthenticated = + const GraphQLError(message: 'User is not authenticated'); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md new file mode 100644 index 0000000000..032289659a --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/userNotFound.md @@ -0,0 +1,33 @@ + + + +# userNotFound property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) userNotFound + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError userNotFound = const GraphQLError(message: 'User not found'); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md new file mode 100644 index 0000000000..a0a4a26d5b --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/DataBaseMutationFunctions/wrongCredentials.md @@ -0,0 +1,34 @@ + + + +# wrongCredentials property + + + + + + + +[GraphQLError](https://pub.dev/documentation/gql_exec/1.0.1-alpha+1690479830973/execution/GraphQLError-class.html) wrongCredentials + +_read / write_ + + + +

Graphql error for handling.

+ + + +## Implementation + +```dart +GraphQLError wrongCredentials = + const GraphQLError(message: 'Invalid credentials'); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_database_mutation_functions/services_database_mutation_functions-library.md b/talawa-mobile-docs/services_database_mutation_functions/services_database_mutation_functions-library.md new file mode 100644 index 0000000000..31230d7d5f --- /dev/null +++ b/talawa-mobile-docs/services_database_mutation_functions/services_database_mutation_functions-library.md @@ -0,0 +1,38 @@ + + + + +# database_mutation_functions library + + + + + + + + + + + +## Classes + +##### [DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions-class.md) + + + +DataBaseMutationFunctions class provides different services that are under the context of graphQL mutations and queries. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService-class.md b/talawa-mobile-docs/services_event_service/EventService-class.md new file mode 100644 index 0000000000..7a9e701c0a --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService-class.md @@ -0,0 +1,174 @@ + + + +# EventService class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[EventService](../services_event_service/EventService/EventService.md) () + + + + +## 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)> + + + +The event stream. +_read-only_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +This function is used to delete the event. + + + + +##### [dispose](../services_event_service/EventService/dispose.md)() void + + + +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> + + + +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) + + + +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> + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_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) + + + +This function is used to register user for an event. + + + + +##### [setOrgStreamSubscription](../services_event_service/EventService/setOrgStreamSubscription.md)() void + + + +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/EventService.md b/talawa-mobile-docs/services_event_service/EventService/EventService.md new file mode 100644 index 0000000000..8d9d309765 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/EventService.md @@ -0,0 +1,34 @@ + + + +# EventService constructor + + + + + + + +EventService() + + + + + +## Implementation + +```dart +EventService() { + _eventStream = _eventStreamController.stream.asBroadcastStream(); + _currentOrg = _userConfig.currentOrg; + _userConfig.initialiseStream(); + setOrgStreamSubscription(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md b/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md new file mode 100644 index 0000000000..3c3c53776d --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/deleteEvent.md @@ -0,0 +1,55 @@ + + + +# deleteEvent method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future deleteEvent(String eventId) async { + navigationService.pushDialog( + const CustomProgressDialog(key: Key('DeleteEventProgress')), + ); + final tokenResult = await _dbFunctions + .refreshAccessToken(userConfig.currentUser.refreshToken!); + debugPrint(tokenResult.toString()); + final result = await _dbFunctions.gqlAuthMutation( + EventQueries().deleteEvent(eventId), + ); + navigationService.pop(); + return result; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/dispose.md b/talawa-mobile-docs/services_event_service/EventService/dispose.md new file mode 100644 index 0000000000..5eb528fee8 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/dispose.md @@ -0,0 +1,41 @@ + + + +# dispose method + + + + + + + + +void dispose +() + + + + + +

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

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void dispose() { + _currentOrganizationStreamSubscription.cancel(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/editEvent.md b/talawa-mobile-docs/services_event_service/EventService/editEvent.md new file mode 100644 index 0000000000..51f6f640e5 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/editEvent.md @@ -0,0 +1,68 @@ + + + +# editEvent method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future editEvent({ + required String eventId, + required Map variables, +}) async { + navigationService.pushDialog( + const CustomProgressDialog( + key: Key('EditEventProgress'), + ), + ); + final tokenResult = await _dbFunctions + .refreshAccessToken(userConfig.currentUser.refreshToken!); + debugPrint(tokenResult.toString()); + final result = await _dbFunctions.gqlAuthMutation( + EventQueries().updateEvent(eventId: eventId), + variables: variables, + ); + navigationService.pop(); + if (result != null) { + navigationService.removeAllAndPush( + Routes.exploreEventsScreen, + Routes.mainScreen, + arguments: MainScreenArgs(mainScreenIndex: 0, fromSignUp: false), + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/eventStream.md b/talawa-mobile-docs/services_event_service/EventService/eventStream.md new file mode 100644 index 0000000000..e243c83859 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/eventStream.md @@ -0,0 +1,42 @@ + + + +# eventStream property + + + + + + + + + +[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventStream + + + + + +

The event stream.

+

params: +None +returns:

+
    +
  • Stream<Event>: returns the event stream
  • +
+ + + +## Implementation + +```dart +Stream get eventStream => _eventStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md b/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md new file mode 100644 index 0000000000..5125946240 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/fetchRegistrantsByEvent.md @@ -0,0 +1,49 @@ + + + +# fetchRegistrantsByEvent method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future fetchRegistrantsByEvent(String eventId) async { + await _dbFunctions.refreshAccessToken(userConfig.currentUser.refreshToken!); + final result = await _dbFunctions.gqlAuthQuery( + EventQueries().registrantsByEvent(eventId), + ); + return result; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/getEvents.md b/talawa-mobile-docs/services_event_service/EventService/getEvents.md new file mode 100644 index 0000000000..031bd6276c --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/getEvents.md @@ -0,0 +1,62 @@ + + + +# getEvents method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future getEvents() async { + // refresh user's access token + await _dbFunctions.refreshAccessToken(userConfig.currentUser.refreshToken!); + _dbFunctions.init(); + + // get current organization id + final String currentOrgID = _currentOrg.id!; + // 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); + event.isRegistered = event.registrants?.any( + (registrant) => registrant.id == _userConfig.currentUser.id, + ) ?? + false; + _eventStreamController.add(event); + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md b/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md new file mode 100644 index 0000000000..d0714cd545 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/registerForAnEvent.md @@ -0,0 +1,53 @@ + + + +# registerForAnEvent method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future registerForAnEvent(String eventId) async { + final tokenResult = await _dbFunctions + .refreshAccessToken(userConfig.currentUser.refreshToken!); + debugPrint(tokenResult.toString()); + final Map variables = {'eventId': eventId}; + final result = await _dbFunctions.gqlAuthMutation( + EventQueries().registerForEvent(), + variables: variables, + ); + return result; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md b/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md new file mode 100644 index 0000000000..3aae014067 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/EventService/setOrgStreamSubscription.md @@ -0,0 +1,44 @@ + + + +# setOrgStreamSubscription method + + + + + + + + +void setOrgStreamSubscription +() + + + + + +

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

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void setOrgStreamSubscription() { + _currentOrganizationStreamSubscription = + _userConfig.currentOrgInfoStream.listen((updatedOrganization) { + _currentOrg = updatedOrganization; + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_event_service/services_event_service-library.md b/talawa-mobile-docs/services_event_service/services_event_service-library.md new file mode 100644 index 0000000000..61682396c8 --- /dev/null +++ b/talawa-mobile-docs/services_event_service/services_event_service-library.md @@ -0,0 +1,38 @@ + + + + +# event_service library + + + + + + + + + + + +## Classes + +##### [EventService](../services_event_service/EventService-class.md) + + + +EventService class provides different services in the context of Event. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md new file mode 100644 index 0000000000..9d5a105a25 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig-class.md @@ -0,0 +1,207 @@ + + + +# GraphqlConfig class + + + + + + + + + +

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.

+ + + + +## Constructors + +[GraphqlConfig](../services_graphql_config/GraphqlConfig/GraphqlConfig.md) () + + + + +## Properties + +##### [displayImgRoute](../services_graphql_config/GraphqlConfig/displayImgRoute.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [webSocketLink](../services_graphql_config/GraphqlConfig/webSocketLink.md) ↔ [WebSocketLink](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/WebSocketLink-class.html) + + + + +_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) + + + + + + + + +##### [clientToQuery](../services_graphql_config/GraphqlConfig/clientToQuery.md)() [GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) + + + + + + + + +##### [getOrgUrl](../services_graphql_config/GraphqlConfig/getOrgUrl.md)() void + + + +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) + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [test](../services_graphql_config/GraphqlConfig/test.md)() void + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + +## Static Properties + +##### [orgURI](../services_graphql_config/GraphqlConfig/orgURI.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + +##### [token](../services_graphql_config/GraphqlConfig/token.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_read / write_ + + + + + + + + +## Constants + +##### [imageUrlKey](../services_graphql_config/GraphqlConfig/imageUrlKey-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/talawa-mobile-docs/services_graphql_config/GraphqlConfig/GraphqlConfig.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/GraphqlConfig.md new file mode 100644 index 0000000000..035b0463c6 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/GraphqlConfig.md @@ -0,0 +1,24 @@ + + + +# GraphqlConfig constructor + + + + + + + +GraphqlConfig() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md new file mode 100644 index 0000000000..aaacdd3202 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/authClient.md @@ -0,0 +1,41 @@ + + + +# authClient method + + + + + + + + +[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) authClient +() + + + + + + + + +## Implementation + +```dart +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/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md new file mode 100644 index 0000000000..25b35a9ac6 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/clientToQuery.md @@ -0,0 +1,42 @@ + + + +# clientToQuery method + + + + + + + + +[GraphQLClient](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/GraphQLClient-class.html) clientToQuery +() + + + + + + + + +## Implementation + +```dart +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/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md new file mode 100644 index 0000000000..0f5ca85202 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/displayImgRoute.md @@ -0,0 +1,32 @@ + + + +# displayImgRoute property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? displayImgRoute + +_read / write_ + + + + + + +## Implementation + +```dart +String? displayImgRoute; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md new file mode 100644 index 0000000000..fceac943c5 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getOrgUrl.md @@ -0,0 +1,44 @@ + + + +# getOrgUrl method + + + + + + + + +void getOrgUrl +() + + + + + +

This function is used to get the organization URL.

+ + + +## Implementation + +```dart +void getOrgUrl() { + final box = Hive.box('url'); + final String? url = box.get(urlKey) as String?; + final String? imgUrl = box.get(imageUrlKey) as String?; + orgURI = url ?? ' '; + displayImgRoute = imgUrl ?? ' '; + httpLink = HttpLink(orgURI!); + clientToQuery(); + authClient(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md new file mode 100644 index 0000000000..e2d6dda0da --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/getToken.md @@ -0,0 +1,40 @@ + + + +# getToken method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) getToken +() + + + + + +

This function is used to get user the access token.

+ + + +## Implementation + +```dart +Future getToken() async { + final authToken = userConfig.currentUser.authToken; + token = authToken; + getOrgUrl(); + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md new file mode 100644 index 0000000000..763c796123 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/httpLink.md @@ -0,0 +1,32 @@ + + + +# httpLink property + + + + + + + +[HttpLink](https://pub.dev/documentation/gql_http_link/1.0.1/gql_http_link/HttpLink-class.html) httpLink + +_read / write_ + + + + + + +## Implementation + +```dart +late HttpLink httpLink; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md new file mode 100644 index 0000000000..e12d339b1c --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/imageUrlKey-constant.md @@ -0,0 +1,32 @@ + + + +# imageUrlKey constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const imageUrlKey + + + + + + + + +## Implementation + +```dart +static const imageUrlKey = "imageUrl"; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md new file mode 100644 index 0000000000..4c6dd02995 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/orgURI.md @@ -0,0 +1,32 @@ + + + +# orgURI property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? orgURI + +_read / write_ + + + + + + +## Implementation + +```dart +static String? orgURI = ' '; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md new file mode 100644 index 0000000000..8b19dcfa4c --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/test.md @@ -0,0 +1,39 @@ + + + +# test method + + + + + + + + +void test +() + + + + + + + + +## Implementation + +```dart +void test() { + httpLink = HttpLink( + 'https://talawa-graphql-api.herokuapp.com/graphql', + httpClient: MockHttpClient(), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md new file mode 100644 index 0000000000..16321bc257 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/token.md @@ -0,0 +1,32 @@ + + + +# token property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? token + +_read / write_ + + + + + + +## Implementation + +```dart +static String? token; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md new file mode 100644 index 0000000000..d90752c598 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/urlKey-constant.md @@ -0,0 +1,32 @@ + + + +# urlKey constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const urlKey + + + + + + + + +## Implementation + +```dart +static const urlKey = "url"; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md new file mode 100644 index 0000000000..1284f5e825 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/GraphqlConfig/webSocketLink.md @@ -0,0 +1,32 @@ + + + +# webSocketLink property + + + + + + + +[WebSocketLink](https://pub.dev/documentation/graphql/5.2.0-beta.4/graphql/WebSocketLink-class.html) webSocketLink + +_read / write_ + + + + + + +## Implementation + +```dart +late WebSocketLink webSocketLink; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md b/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md new file mode 100644 index 0000000000..44dbf59571 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/MockHttpClient-class.md @@ -0,0 +1,203 @@ + + + +# MockHttpClient class + + + + + + + + + +

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) +- MockHttpClient + +**Implemented types** + +- [Client](https://pub.dev/documentation/http/0.13.6/http/Client-class.html) + + + + + + + +## Constructors + +[MockHttpClient](../services_graphql_config/MockHttpClient/MockHttpClient.md) () + + + + +## 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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/MockHttpClient/MockHttpClient.md b/talawa-mobile-docs/services_graphql_config/MockHttpClient/MockHttpClient.md new file mode 100644 index 0000000000..e5de34c930 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/MockHttpClient/MockHttpClient.md @@ -0,0 +1,24 @@ + + + +# MockHttpClient constructor + + + + + + + +MockHttpClient() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md b/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md new file mode 100644 index 0000000000..d2358b9041 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/MockHttpClient/send.md @@ -0,0 +1,47 @@ + + + +# send method + + + + + + + +- @[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) + +_override_ + + + +

Sends an HTTP request and asynchronously returns the response.

+ + + +## Implementation + +```dart +@override +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 [[]]), + 500, + ), + ), + ) as Future; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md b/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md new file mode 100644 index 0000000000..ddc74cda14 --- /dev/null +++ b/talawa-mobile-docs/services_graphql_config/services_graphql_config-library.md @@ -0,0 +1,48 @@ + + + + +# graphql_config library + + + + + + + + + + + +## Classes + +##### [GraphqlConfig](../services_graphql_config/GraphqlConfig-class.md) + + + +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. + + +##### [MockHttpClient](../services_graphql_config/MockHttpClient-class.md) + + + +A mock HTTP client designed for use when testing code that uses BaseClient. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService-class.md b/talawa-mobile-docs/services_navigation_service/NavigationService-class.md new file mode 100644 index 0000000000..5485dfc4e0 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService-class.md @@ -0,0 +1,203 @@ + + + +# NavigationService class + + + + + + + + + +

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

+

Services include:

+
    +
  • pushScreen
  • +
  • popAndPushScreen
  • +
  • pushReplacementScreen
  • +
  • removeAllAndPush
  • +
  • showSnackBar
  • +
  • pushDialog
  • +
  • showTalawaErrorWidget
  • +
  • showTalawaErrorDialog
  • +
  • pop
  • +
+ + + + +## Constructors + +[NavigationService](../services_navigation_service/NavigationService/NavigationService.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + + + + + + +##### [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_ + + + +##### [pop](../services_navigation_service/NavigationService/pop.md)() void + + + +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) + + + +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 + + + +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) + + + +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) + + + +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) + + + +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 + + + +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 + + + + + + + + +##### [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 + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/NavigationService.md b/talawa-mobile-docs/services_navigation_service/NavigationService/NavigationService.md new file mode 100644 index 0000000000..e32f964554 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/NavigationService.md @@ -0,0 +1,24 @@ + + + +# NavigationService constructor + + + + + + + +NavigationService() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md b/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md new file mode 100644 index 0000000000..e65d09b548 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/fromInviteLink.md @@ -0,0 +1,40 @@ + + + +# fromInviteLink method + + + + + + + + +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) + + + + + + + + +## Implementation + +```dart +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]); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md b/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md new file mode 100644 index 0000000000..ba78b322e3 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/navigatorKey.md @@ -0,0 +1,32 @@ + + + +# navigatorKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[NavigatorState](https://api.flutter.dev/flutter/widgets/NavigatorState-class.html)> navigatorKey + +_read / write_ + + + + + + +## Implementation + +```dart +GlobalKey navigatorKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md b/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md new file mode 100644 index 0000000000..fcf90d6f10 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/pop.md @@ -0,0 +1,37 @@ + + + +# pop method + + + + + + + + +void pop +() + + + + + +

This function pops the current state.

+ + + +## Implementation + +```dart +void pop() { + return navigatorKey.currentState!.pop(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md b/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md new file mode 100644 index 0000000000..2dd7b0e99e --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/popAndPushScreen.md @@ -0,0 +1,43 @@ + + + +# popAndPushScreen method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future popAndPushScreen(String routeName, {dynamic arguments}) { + navigatorKey.currentState!.pop(); + return pushScreen(routeName, arguments: arguments); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md b/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md new file mode 100644 index 0000000000..1c6f2e7e0b --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/pushDialog.md @@ -0,0 +1,44 @@ + + + +# pushDialog method + + + + + + + + +void pushDialog +([Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) dialog) + + + + + +

This function is used to show the custom Dialog.

+ + + +## Implementation + +```dart +void pushDialog(Widget dialog) { + showDialog( + context: navigatorKey.currentContext!, + barrierColor: Colors.transparent, + barrierDismissible: false, + builder: (BuildContext context) { + return dialog; + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md b/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md new file mode 100644 index 0000000000..d424e9278e --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/pushReplacementScreen.md @@ -0,0 +1,43 @@ + + + +# pushReplacementScreen method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future pushReplacementScreen(String routeName, {dynamic arguments}) { + return navigatorKey.currentState! + .pushReplacementNamed(routeName, arguments: arguments); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md b/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md new file mode 100644 index 0000000000..cee2216131 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/pushScreen.md @@ -0,0 +1,43 @@ + + + +# pushScreen method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future pushScreen(String routeName, {dynamic arguments}) { + return navigatorKey.currentState! + .pushNamed(routeName, arguments: arguments); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md b/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md new file mode 100644 index 0000000000..675e9d4303 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/removeAllAndPush.md @@ -0,0 +1,51 @@ + + + +# removeAllAndPush method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future removeAllAndPush( + String routeName, + String tillRoute, { + dynamic arguments, +}) { + return navigatorKey.currentState!.pushNamedAndRemoveUntil( + routeName, + ModalRoute.withName(tillRoute), + arguments: arguments, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md b/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md new file mode 100644 index 0000000000..26dee20c01 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/showSnackBar.md @@ -0,0 +1,46 @@ + + + +# showSnackBar method + + + + + + + + +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)}) + + + + + +

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

+ + + +## Implementation + +```dart +void showSnackBar( + String message, { + Duration duration = const Duration(seconds: 2), +}) { + ScaffoldMessenger.of(navigatorKey.currentContext!).showSnackBar( + SnackBar( + behavior: SnackBarBehavior.floating, + duration: duration, + content: Text(message), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md b/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md new file mode 100644 index 0000000000..553dac12b7 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorDialog.md @@ -0,0 +1,46 @@ + + + +# showTalawaErrorDialog method + + + + + + + + +void showTalawaErrorDialog +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage, [MessageType](../../enums_enums/MessageType.md) messageType) + + + + + + + + +## Implementation + +```dart +void showTalawaErrorDialog(String errorMessage, MessageType messageType) { + showDialog( + context: navigatorKey.currentContext!, + barrierColor: Colors.transparent, + barrierDismissible: false, + builder: (BuildContext context) { + return TalawaErrorDialog( + errorMessage, + messageType: messageType, + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md b/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md new file mode 100644 index 0000000000..565c775000 --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/NavigationService/showTalawaErrorSnackBar.md @@ -0,0 +1,49 @@ + + + +# showTalawaErrorSnackBar method + + + + + + + + +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)}) + + + + + + + + +## Implementation + +```dart +void showTalawaErrorSnackBar( + String errorMessage, + MessageType messageType, { + Duration duration = const Duration(seconds: 2), +}) { + ScaffoldMessenger.of(navigatorKey.currentContext!).showSnackBar( + SnackBar( + padding: EdgeInsets.zero, + content: TalawaErrorSnackBar( + messageType: messageType, + errorMessage: errorMessage, + ), + backgroundColor: const Color.fromRGBO(65, 65, 66, 1), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_navigation_service/services_navigation_service-library.md b/talawa-mobile-docs/services_navigation_service/services_navigation_service-library.md new file mode 100644 index 0000000000..5ce8587f9e --- /dev/null +++ b/talawa-mobile-docs/services_navigation_service/services_navigation_service-library.md @@ -0,0 +1,38 @@ + + + + +# navigation_service library + + + + + + + + + + + +## Classes + +##### [NavigationService](../services_navigation_service/NavigationService-class.md) + + + +NavigationService class provides different functions as service in the context of navigation. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_org_service/OrganizationService-class.md b/talawa-mobile-docs/services_org_service/OrganizationService-class.md new file mode 100644 index 0000000000..dec4225197 --- /dev/null +++ b/talawa-mobile-docs/services_org_service/OrganizationService-class.md @@ -0,0 +1,105 @@ + + + +# OrganizationService class + + + + + + + + + +

OrganizationService class provides the in the context of organizations.

+

Services include:

+
    +
  • getOrgMembersList : to get all organizations members
  • +
+ + + + +## Constructors + +[OrganizationService](../services_org_service/OrganizationService/OrganizationService.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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)>> + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md b/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md new file mode 100644 index 0000000000..6827db76d6 --- /dev/null +++ b/talawa-mobile-docs/services_org_service/OrganizationService/OrganizationService.md @@ -0,0 +1,31 @@ + + + +# OrganizationService constructor + + + + + + + +OrganizationService() + + + + + +## Implementation + +```dart +OrganizationService() { + _dbFunctions = locator(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md b/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md new file mode 100644 index 0000000000..b44d1f1ded --- /dev/null +++ b/talawa-mobile-docs/services_org_service/OrganizationService/getOrgMembersList.md @@ -0,0 +1,54 @@ + + + +# getOrgMembersList method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future> getOrgMembersList(String orgId) async { + final String query = Queries().fetchOrgDetailsById(orgId); + // 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 User member = + User.fromJson(jsonElement as Map, fromOrg: true); + orgMembersList.add(member); + }); + + // return list + return orgMembersList; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_org_service/services_org_service-library.md b/talawa-mobile-docs/services_org_service/services_org_service-library.md new file mode 100644 index 0000000000..13bfece069 --- /dev/null +++ b/talawa-mobile-docs/services_org_service/services_org_service-library.md @@ -0,0 +1,38 @@ + + + + +# org_service library + + + + + + + + + + + +## Classes + +##### [OrganizationService](../services_org_service/OrganizationService-class.md) + + + +OrganizationService class provides the in the context of organizations. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService-class.md b/talawa-mobile-docs/services_post_service/PostService-class.md new file mode 100644 index 0000000000..41a1ca6830 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService-class.md @@ -0,0 +1,162 @@ + + + +# PostService class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[PostService](../services_post_service/PostService/PostService.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [addCommentLocally](../services_post_service/PostService/addCommentLocally.md)([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) 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> + + + +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> + + + +This function used to get all posts of an organization. +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 + + + +Invoked when a non-existent method or property is accessed. +_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> + + + +This function is used to remove like from the Post. + + + + +##### [setOrgStreamSubscription](../services_post_service/PostService/setOrgStreamSubscription.md)() void + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/PostService.md b/talawa-mobile-docs/services_post_service/PostService/PostService.md new file mode 100644 index 0000000000..0ee01b0b66 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/PostService.md @@ -0,0 +1,36 @@ + + + +# PostService constructor + + + + + + + +PostService() + + + + + +## Implementation + +```dart +PostService() { + _postStream = _postStreamController.stream.asBroadcastStream(); + _updatedPostStream = + _updatedPostStreamController.stream.asBroadcastStream(); + _currentOrg = _userConfig.currentOrg; + setOrgStreamSubscription(); + getPosts(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md b/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md new file mode 100644 index 0000000000..f2123c5d58 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/addCommentLocally.md @@ -0,0 +1,41 @@ + + + +# addCommentLocally method + + + + + + + + +void addCommentLocally +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) + + + + + + + + +## Implementation + +```dart +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/talawa-mobile-docs/services_post_service/PostService/addLike.md b/talawa-mobile-docs/services_post_service/PostService/addLike.md new file mode 100644 index 0000000000..6e68fdc7f6 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/addLike.md @@ -0,0 +1,48 @@ + + + +# addLike method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future addLike(String postID) async { + _localAddLike(postID); + final String mutation = PostQueries().addLike(); + // run the graphQl mutation. + final result = await _dbFunctions + .gqlAuthMutation(mutation, variables: {"postID": postID}); + print(result); + // return result + return result; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/getPosts.md b/talawa-mobile-docs/services_post_service/PostService/getPosts.md new file mode 100644 index 0000000000..84b9cdacb2 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/getPosts.md @@ -0,0 +1,55 @@ + + + +# getPosts method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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. + 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)) { + _posts.insert(0, post); + _renderedPostID.add(post.sId); + } + }); + _postStreamController.add(_posts); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/postStream.md b/talawa-mobile-docs/services_post_service/PostService/postStream.md new file mode 100644 index 0000000000..80065aede1 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/postStream.md @@ -0,0 +1,35 @@ + + + +# postStream property + + + + + + + + + +[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 + + + + + + + + +## Implementation + +```dart +Stream> get postStream => _postStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/removeLike.md b/talawa-mobile-docs/services_post_service/PostService/removeLike.md new file mode 100644 index 0000000000..fed21d0195 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/removeLike.md @@ -0,0 +1,46 @@ + + + +# removeLike method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future removeLike(String postID) async { + _removeLocal(postID); + final String mutation = PostQueries().removeLike(); + final result = await _dbFunctions + .gqlAuthMutation(mutation, variables: {"postID": postID}); + print(result); + return result; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md b/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md new file mode 100644 index 0000000000..f4ee899b49 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/setOrgStreamSubscription.md @@ -0,0 +1,43 @@ + + + +# setOrgStreamSubscription method + + + + + + + + +void setOrgStreamSubscription +() + + + + + + + + +## Implementation + +```dart +void setOrgStreamSubscription() { + _userConfig.currentOrgInfoStream.listen((updatedOrganization) { + if (updatedOrganization != _currentOrg) { + print("org changes from post service"); + _renderedPostID.clear(); + _currentOrg = updatedOrganization; + getPosts(); + } + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md b/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md new file mode 100644 index 0000000000..3048a2fe6d --- /dev/null +++ b/talawa-mobile-docs/services_post_service/PostService/updatedPostStream.md @@ -0,0 +1,35 @@ + + + +# updatedPostStream property + + + + + + + + + +[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[Post](../../models_post_post_model/Post-class.md)> updatedPostStream + + + + + + + + +## Implementation + +```dart +Stream get updatedPostStream => _updatedPostStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_post_service/services_post_service-library.md b/talawa-mobile-docs/services_post_service/services_post_service-library.md new file mode 100644 index 0000000000..4a739d0e29 --- /dev/null +++ b/talawa-mobile-docs/services_post_service/services_post_service-library.md @@ -0,0 +1,38 @@ + + + + +# post_service library + + + + + + + + + + + +## Classes + +##### [PostService](../services_post_service/PostService-class.md) + + + +PostService class provides functions in the context of a Post. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig-class.md b/talawa-mobile-docs/services_size_config/SizeConfig-class.md new file mode 100644 index 0000000000..d0897bbeb2 --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig-class.md @@ -0,0 +1,175 @@ + + + +# SizeConfig class + + + + + + + + + +

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

+ + + + +## Constructors + +[SizeConfig](../services_size_config/SizeConfig/SizeConfig.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [init](../services_size_config/SizeConfig/init.md)([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) void + + + + + + + + +##### [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_ + + + +##### [test](../services_size_config/SizeConfig/test.md)() void + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + +## Static Properties + +##### [blockSizeHorizontal](../services_size_config/SizeConfig/blockSizeHorizontal.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [blockSizeVertical](../services_size_config/SizeConfig/blockSizeVertical.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [paddingTop](../services_size_config/SizeConfig/paddingTop.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [safeBlockHorizontal](../services_size_config/SizeConfig/safeBlockHorizontal.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [safeBlockVertical](../services_size_config/SizeConfig/safeBlockVertical.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [screenHeight](../services_size_config/SizeConfig/screenHeight.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + +##### [screenWidth](../services_size_config/SizeConfig/screenWidth.md) ↔ [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_read / write_ + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/SizeConfig.md b/talawa-mobile-docs/services_size_config/SizeConfig/SizeConfig.md new file mode 100644 index 0000000000..7a2926039e --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/SizeConfig.md @@ -0,0 +1,24 @@ + + + +# SizeConfig constructor + + + + + + + +SizeConfig() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md b/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md new file mode 100644 index 0000000000..c497d83ad2 --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeHorizontal.md @@ -0,0 +1,32 @@ + + + +# blockSizeHorizontal property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? blockSizeHorizontal + +_read / write_ + + + + + + +## Implementation + +```dart +static double? blockSizeHorizontal; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md b/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md new file mode 100644 index 0000000000..1d691b2cfb --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/blockSizeVertical.md @@ -0,0 +1,32 @@ + + + +# blockSizeVertical property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? blockSizeVertical + +_read / write_ + + + + + + +## Implementation + +```dart +static double? blockSizeVertical; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/init.md b/talawa-mobile-docs/services_size_config/SizeConfig/init.md new file mode 100644 index 0000000000..7938803390 --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/init.md @@ -0,0 +1,49 @@ + + + +# init method + + + + + + + + +void init +([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) + + + + + + + + +## Implementation + +```dart +void init(BuildContext context) { + _mediaQueryData = MediaQuery.of(context); + screenWidth = _mediaQueryData.size.width; + screenHeight = _mediaQueryData.size.height; + blockSizeHorizontal = screenWidth! / 100; + blockSizeVertical = screenHeight! / 100; + + _safeAreaHorizontal = + _mediaQueryData.padding.left + _mediaQueryData.padding.right; + _safeAreaVertical = + _mediaQueryData.padding.top + _mediaQueryData.padding.bottom; + safeBlockHorizontal = (screenWidth! - _safeAreaHorizontal) / 100; + safeBlockVertical = (screenHeight! - _safeAreaVertical) / 100; + debugPrint("safeBlockHorizontal: $safeBlockHorizontal"); + debugPrint("safeBlockVertical: $safeBlockVertical"); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md b/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md new file mode 100644 index 0000000000..28987e0b3e --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/paddingTop.md @@ -0,0 +1,32 @@ + + + +# paddingTop property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? paddingTop + +_read / write_ + + + + + + +## Implementation + +```dart +static double? paddingTop; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md b/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md new file mode 100644 index 0000000000..296f95581e --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockHorizontal.md @@ -0,0 +1,32 @@ + + + +# safeBlockHorizontal property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? safeBlockHorizontal + +_read / write_ + + + + + + +## Implementation + +```dart +static double? safeBlockHorizontal; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md b/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md new file mode 100644 index 0000000000..aa09b2ba74 --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/safeBlockVertical.md @@ -0,0 +1,32 @@ + + + +# safeBlockVertical property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? safeBlockVertical + +_read / write_ + + + + + + +## Implementation + +```dart +static double? safeBlockVertical; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md b/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md new file mode 100644 index 0000000000..4aab01da1d --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/screenHeight.md @@ -0,0 +1,32 @@ + + + +# screenHeight property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? screenHeight + +_read / write_ + + + + + + +## Implementation + +```dart +static double? screenHeight; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md b/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md new file mode 100644 index 0000000000..5f14d7c953 --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/screenWidth.md @@ -0,0 +1,32 @@ + + + +# screenWidth property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? screenWidth + +_read / write_ + + + + + + +## Implementation + +```dart +static double? screenWidth; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/SizeConfig/test.md b/talawa-mobile-docs/services_size_config/SizeConfig/test.md new file mode 100644 index 0000000000..1f2a3819ed --- /dev/null +++ b/talawa-mobile-docs/services_size_config/SizeConfig/test.md @@ -0,0 +1,48 @@ + + + +# test method + + + + + + + + +void test +() + + + + + + + + +## Implementation + +```dart +void test() { + _mediaQueryData = + const MediaQueryData(size: Size(360, 684), padding: EdgeInsets.zero); + screenWidth = _mediaQueryData.size.width; + screenHeight = _mediaQueryData.size.height; + blockSizeHorizontal = screenWidth! / 100; + blockSizeVertical = screenHeight! / 100; + + _safeAreaHorizontal = + _mediaQueryData.padding.left + _mediaQueryData.padding.right; + _safeAreaVertical = + _mediaQueryData.padding.top + _mediaQueryData.padding.bottom; + safeBlockHorizontal = (screenWidth! - _safeAreaHorizontal) / 100; + safeBlockVertical = (screenHeight! - _safeAreaVertical) / 100; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_size_config/services_size_config-library.md b/talawa-mobile-docs/services_size_config/services_size_config-library.md new file mode 100644 index 0000000000..040d2d32b0 --- /dev/null +++ b/talawa-mobile-docs/services_size_config/services_size_config-library.md @@ -0,0 +1,38 @@ + + + + +# size_config library + + + + + + + + + + + +## Classes + +##### [SizeConfig](../services_size_config/SizeConfig-class.md) + + + +SizeConfig class is used to initialise the height and width of the media. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService-class.md b/talawa-mobile-docs/services_task_service/TaskService-class.md new file mode 100644 index 0000000000..12a51accd4 --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService-class.md @@ -0,0 +1,163 @@ + + + +# TaskService class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[TaskService](../services_task_service/TaskService/TaskService.md) () + + + + +## Properties + +##### [callbackNotifyListeners](../services_task_service/TaskService/callbackNotifyListeners.md) ↔ [VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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)> + + + +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> + + + +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)> + + + +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> + + + +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> + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/TaskService.md b/talawa-mobile-docs/services_task_service/TaskService/TaskService.md new file mode 100644 index 0000000000..14f9eba9f4 --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/TaskService.md @@ -0,0 +1,24 @@ + + + +# TaskService constructor + + + + + + + +TaskService() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md b/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md new file mode 100644 index 0000000000..13f1edc6f2 --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/callbackNotifyListeners.md @@ -0,0 +1,32 @@ + + + +# callbackNotifyListeners property + + + + + + + +[VoidCallback](https://api.flutter.dev/flutter/dart-ui/VoidCallback.html) callbackNotifyListeners + +_read / write_ + + + + + + +## Implementation + +```dart +late VoidCallback callbackNotifyListeners; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/createTask.md b/talawa-mobile-docs/services_task_service/TaskService/createTask.md new file mode 100644 index 0000000000..3e08ed9d61 --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/createTask.md @@ -0,0 +1,66 @@ + + + +# createTask method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future createTask({ + required String title, + required String description, + required String deadline, + required String eventId, +}) async { + _databaseMutationFunctions + .refreshAccessToken(_userConfig.currentUser.refreshToken!); + final res = await _databaseMutationFunctions.gqlAuthMutation( + TaskQueries.addTask( + title: title, + description: description, + deadline: deadline, + eventId: eventId, + ), + ); + + if (res != null) { + final task = res.data!['createTask'] as Map; + _tasks.add(Task.fromJson(task)); + callbackNotifyListeners(); + return true; + } + return false; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md b/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md new file mode 100644 index 0000000000..2487482bc9 --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/deleteTask.md @@ -0,0 +1,48 @@ + + + +# deleteTask method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/editTask.md b/talawa-mobile-docs/services_task_service/TaskService/editTask.md new file mode 100644 index 0000000000..e0ff4bf2c2 --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/editTask.md @@ -0,0 +1,72 @@ + + + +# editTask method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future editTask({ + required String title, + required String description, + required String deadline, + required String taskId, +}) async { + _databaseMutationFunctions + .refreshAccessToken(_userConfig.currentUser.refreshToken!); + final res = await _databaseMutationFunctions.gqlAuthMutation( + TaskQueries.editTask( + title: title, + description: description, + deadline: deadline, + taskId: 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. + return true; + } + return false; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md b/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md new file mode 100644 index 0000000000..ce9e59af3c --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/getTasksByUser.md @@ -0,0 +1,48 @@ + + + +# getTasksByUser method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future getTasksByUser() async { + await _databaseMutationFunctions + .refreshAccessToken(_userConfig.currentUser.refreshToken!); + final res = await _databaseMutationFunctions + .gqlNonAuthQuery(TaskQueries.userTasks(_userConfig.currentUser.id!)); + + if (res != null) { + _tasks.clear(); + final tasksList = res.data!['tasksByUser'] as List; + tasksList.forEach((task) { + _tasks.add(Task.fromJson(task as Map)); + }); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md b/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md new file mode 100644 index 0000000000..21536bf75f --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/getTasksForEvent.md @@ -0,0 +1,52 @@ + + + +# getTasksForEvent method + + + + + + + + +[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,
  • +
+ + + +## Implementation + +```dart +Future getTasksForEvent(String eventId) async { + await _databaseMutationFunctions + .refreshAccessToken(_userConfig.currentUser.refreshToken!); + final res = await _databaseMutationFunctions + .gqlNonAuthQuery(TaskQueries.eventTasks(eventId)); + + if (res != null) { + _tasks.clear(); + final tasksList = res.data!['tasksByEvent'] as List; + tasksList.forEach((task) { + _tasks.add(Task.fromJson(task as Map)); + }); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/TaskService/tasks.md b/talawa-mobile-docs/services_task_service/TaskService/tasks.md new file mode 100644 index 0000000000..aad6505b3b --- /dev/null +++ b/talawa-mobile-docs/services_task_service/TaskService/tasks.md @@ -0,0 +1,35 @@ + + + +# tasks property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks + + + + + + + + +## Implementation + +```dart +List get tasks => _tasks; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_task_service/services_task_service-library.md b/talawa-mobile-docs/services_task_service/services_task_service-library.md new file mode 100644 index 0000000000..74a1bb179e --- /dev/null +++ b/talawa-mobile-docs/services_task_service/services_task_service-library.md @@ -0,0 +1,38 @@ + + + + +# task_service library + + + + + + + + + + + +## Classes + +##### [TaskService](../services_task_service/TaskService-class.md) + + + +PostService class provides functions in the context of a Task. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md new file mode 100644 index 0000000000..318a00e235 --- /dev/null +++ b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md @@ -0,0 +1,125 @@ + + + +# MultiMediaPickerService class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[MultiMediaPickerService](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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)?> + + + +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)?> + + + +This function is used to pick the image from gallery or to click the image from user's camera. + + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md new file mode 100644 index 0000000000..28c50264b9 --- /dev/null +++ b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/MultiMediaPickerService.md @@ -0,0 +1,32 @@ + + + +# MultiMediaPickerService constructor + + + + + + + +MultiMediaPickerService() + + + + + +## Implementation + +```dart +MultiMediaPickerService() { + _picker = locator(); + _fileStream = _fileStreamController.stream.asBroadcastStream(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md new file mode 100644 index 0000000000..fdff8f3c19 --- /dev/null +++ b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/cropImage.md @@ -0,0 +1,77 @@ + + + +# cropImage method + + + + + + + + +[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.
  • +
+ + + +## 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( + sourcePath: imageFile.path, + aspectRatioPresets: [ + CropAspectRatioPreset.square, + CropAspectRatioPreset.original, + ], + uiSettings: [ + AndroidUiSettings( + toolbarTitle: 'Crop Image', + toolbarColor: const Color(0xff18191A), + toolbarWidgetColor: Colors.white, + backgroundColor: Colors.black, + cropGridColor: Colors.white, + initAspectRatio: CropAspectRatioPreset.original, + lockAspectRatio: false, + ), + IOSUiSettings( + minimumAspectRatio: 1.0, + ) + ], + ); + if (croppedImage != null) { + return File(croppedImage.path); + } + } catch (e) { + print( + "MultiMediaPickerService : Exception occurred while cropping Image", + ); + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md new file mode 100644 index 0000000000..71d2ea7a2f --- /dev/null +++ b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/fileStream.md @@ -0,0 +1,42 @@ + + + +# fileStream property + + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Stream get fileStream => _fileStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md new file mode 100644 index 0000000000..d97759f541 --- /dev/null +++ b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/MultiMediaPickerService/getPhotoFromGallery.md @@ -0,0 +1,78 @@ + + + +# getPhotoFromGallery method + + + + + + + + +[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.
  • +
+ + + +## 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. + 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) { + 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( + CustomAlertDialog( + 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/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/services_third_party_service_multi_media_pick_service-library.md b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/services_third_party_service_multi_media_pick_service-library.md new file mode 100644 index 0000000000..5eecc0aa82 --- /dev/null +++ b/talawa-mobile-docs/services_third_party_service_multi_media_pick_service/services_third_party_service_multi_media_pick_service-library.md @@ -0,0 +1,38 @@ + + + + +# multi_media_pick_service library + + + + + + + + + + + +## Classes + +##### [MultiMediaPickerService](../services_third_party_service_multi_media_pick_service/MultiMediaPickerService-class.md) + + + +This is a third party service which provide the service to select the image from. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig-class.md b/talawa-mobile-docs/services_user_config/UserConfig-class.md new file mode 100644 index 0000000000..01c67b0d42 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig-class.md @@ -0,0 +1,237 @@ + + + +# UserConfig class + + + + + + + + + +

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.
  • +
+ + + + +## Constructors + +[UserConfig](../services_user_config/UserConfig/UserConfig.md) () + + + + +## Properties + +##### [currentOrg](../services_user_config/UserConfig/currentOrg.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_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)> + + + + +_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)> + + + + +_read-only_ + + + +##### [currentOrgName](../services_user_config/UserConfig/currentOrgName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read-only_ + + + +##### [currentUser](../services_user_config/UserConfig/currentUser.md) ↔ [User](../models_user_user_info/User-class.md) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [initialiseStream](../services_user_config/UserConfig/initialiseStream.md)() void + + + + + + + + +##### [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_ + + + +##### [saveCurrentOrgInHive](../services_user_config/UserConfig/saveCurrentOrgInHive.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) saveOrgAsCurrent) void + + + + + + + + +##### [saveUserInHive](../services_user_config/UserConfig/saveUserInHive.md)() void + + + + + + + + +##### [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_ + + + +##### [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) + + + +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)> + + + +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) + + + +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) + + + +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) + + + +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) + + + +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)> + + + +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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/UserConfig.md b/talawa-mobile-docs/services_user_config/UserConfig/UserConfig.md new file mode 100644 index 0000000000..9472b066e4 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/UserConfig.md @@ -0,0 +1,24 @@ + + + +# UserConfig constructor + + + + + + + +UserConfig() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md b/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md new file mode 100644 index 0000000000..a83a2ef496 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/currentOrg.md @@ -0,0 +1,53 @@ + + + +# currentOrg property + + + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) currentOrg + + + + + + + + +## Implementation + +```dart +OrgInfo get currentOrg => _currentOrg!; +``` + + + + + +currentOrg= +([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org) + + + + + + + +## Implementation + +```dart +set currentOrg(OrgInfo org) => _currentOrg = org; +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md b/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md new file mode 100644 index 0000000000..6fccf53f6c --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoController.md @@ -0,0 +1,36 @@ + + + +# currentOrgInfoController property + + + + + + + + + +[StreamController](https://api.flutter.dev/flutter/dart-async/StreamController-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> currentOrgInfoController + + + + + + + + +## Implementation + +```dart +StreamController get currentOrgInfoController => + _currentOrgInfoController; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md b/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md new file mode 100644 index 0000000000..4a2a60ece5 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/currentOrgInfoStream.md @@ -0,0 +1,35 @@ + + + +# currentOrgInfoStream property + + + + + + + + + +[Stream](https://api.flutter.dev/flutter/dart-async/Stream-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> currentOrgInfoStream + + + + + + + + +## Implementation + +```dart +Stream get currentOrgInfoStream => _currentOrgInfoStream; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md b/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md new file mode 100644 index 0000000000..64d6a00c58 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/currentOrgName.md @@ -0,0 +1,35 @@ + + + +# currentOrgName property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) currentOrgName + + + + + + + + +## Implementation + +```dart +String get currentOrgName => _currentOrg!.name!; +``` + + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md b/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md new file mode 100644 index 0000000000..77f70037a9 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/currentUser.md @@ -0,0 +1,55 @@ + + + +# currentUser property + + + + + + + + + +[User](../../models_user_user_info/User-class.md) currentUser + + + + + + + + +## Implementation + +```dart +User get currentUser => _currentUser!; +``` + + + + + +currentUser= +([User](../../models_user_user_info/User-class.md) user) + + + + + + + +## Implementation + +```dart +set currentUser(User user) { + _currentUser = user; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md b/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md new file mode 100644 index 0000000000..0fda93269c --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/initialiseStream.md @@ -0,0 +1,37 @@ + + + +# initialiseStream method + + + + + + + + +void initialiseStream +() + + + + + + + + +## Implementation + +```dart +void initialiseStream() { + _currentOrgInfoStream = + _currentOrgInfoController.stream.asBroadcastStream(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md b/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md new file mode 100644 index 0000000000..6eb038ac89 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/saveCurrentOrgInHive.md @@ -0,0 +1,43 @@ + + + +# saveCurrentOrgInHive method + + + + + + + + +void saveCurrentOrgInHive +([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) saveOrgAsCurrent) + + + + + + + + +## Implementation + +```dart +void saveCurrentOrgInHive(OrgInfo saveOrgAsCurrent) { + _currentOrg = saveOrgAsCurrent; + _currentOrgInfoController.add(_currentOrg!); + final box = Hive.box('currentOrg'); + if (box.get('org') == null) { + box.put('org', _currentOrg!); + } else { + box.put('org', _currentOrg!); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md b/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md new file mode 100644 index 0000000000..53dcd9a8ab --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/saveUserInHive.md @@ -0,0 +1,41 @@ + + + +# saveUserInHive method + + + + + + + + +void saveUserInHive +() + + + + + + + + +## Implementation + +```dart +void saveUserInHive() { + final box = Hive.box('currentUser'); + if (box.get('user') == null) { + box.put('user', _currentUser!); + } else { + box.put('user', _currentUser!); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md b/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md new file mode 100644 index 0000000000..7d38a3491e --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/updateAccessToken.md @@ -0,0 +1,47 @@ + + + +# updateAccessToken method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future updateAccessToken({ + required String accessToken, + required String refreshToken, +}) async { + _currentUser!.refreshToken = refreshToken; + _currentUser!.authToken = accessToken; + saveUserInHive(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md b/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md new file mode 100644 index 0000000000..d10b9600b2 --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/updateUser.md @@ -0,0 +1,50 @@ + + + +# updateUser method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future updateUser(User updatedUserDetails) async { + try { + _currentUser = updatedUserDetails; + saveUserInHive(); + graphqlConfig.getToken(); + databaseFunctions.init(); + return true; + } on Exception catch (e) { + debugPrint(e.toString()); + return false; + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md b/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md new file mode 100644 index 0000000000..399b73f5ed --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/updateUserAdminOrg.md @@ -0,0 +1,42 @@ + + + +# updateUserAdminOrg method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future updateUserAdminOrg(List orgDetails) async { + _currentUser!.updateAdminFor(orgDetails); + saveUserInHive(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md b/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md new file mode 100644 index 0000000000..36ff305c0b --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/updateUserCreatedOrg.md @@ -0,0 +1,42 @@ + + + +# updateUserCreatedOrg method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future updateUserCreatedOrg(List orgDetails) async { + _currentUser!.updateCreatedOrg(orgDetails); + saveUserInHive(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md b/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md new file mode 100644 index 0000000000..2b99aa06ae --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/updateUserJoinedOrg.md @@ -0,0 +1,42 @@ + + + +# updateUserJoinedOrg method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future updateUserJoinedOrg(List orgDetails) async { + _currentUser!.updateJoinedOrg(orgDetails); + saveUserInHive(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md b/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md new file mode 100644 index 0000000000..8cef35b6af --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/updateUserMemberRequestOrg.md @@ -0,0 +1,42 @@ + + + +# updateUserMemberRequestOrg method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future updateUserMemberRequestOrg(List orgDetails) async { + _currentUser!.updateMemberRequestOrg(orgDetails); + saveUserInHive(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md b/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md new file mode 100644 index 0000000000..7ff776029e --- /dev/null +++ b/talawa-mobile-docs/services_user_config/UserConfig/userLoggedIn.md @@ -0,0 +1,78 @@ + + + +# userLoggedIn method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future userLoggedIn() async { + initialiseStream(); + 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) { + _currentUser = User(id: 'null', authToken: 'null'); + return false; + } + // generate access token + graphqlConfig.getToken().then((value) async { + databaseFunctions.init(); + try { + final QueryResult result = await databaseFunctions.gqlAuthQuery( + queries.fetchUserInfo, + variables: {'id': currentUser.id}, + ) as QueryResult; + final User userInfo = User.fromJson( + result.data!['users'][0] as Map, + fromOrg: true, + ); + userInfo.authToken = userConfig.currentUser.authToken; + userInfo.refreshToken = userConfig.currentUser.refreshToken; + userConfig.updateUser(userInfo); + _currentOrg ??= _currentUser!.joinedOrganizations![0]; + _currentOrgInfoController.add(_currentOrg!); + + saveUserInHive(); + return true; + } on Exception catch (e) { + print(e); + navigationService.showTalawaErrorSnackBar( + "Couldn't update User details", + MessageType.error, + ); + } + }); + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/services_user_config/services_user_config-library.md b/talawa-mobile-docs/services_user_config/services_user_config-library.md new file mode 100644 index 0000000000..3fb10c55dc --- /dev/null +++ b/talawa-mobile-docs/services_user_config/services_user_config-library.md @@ -0,0 +1,38 @@ + + + + +# user_config library + + + + + + + + + + + +## Classes + +##### [UserConfig](../services_user_config/UserConfig-class.md) + + + +UserConfig class provides different services in the context of the User. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/splash_screen/SplashScreen-class.md b/talawa-mobile-docs/splash_screen/SplashScreen-class.md new file mode 100644 index 0000000000..ec5863795f --- /dev/null +++ b/talawa-mobile-docs/splash_screen/SplashScreen-class.md @@ -0,0 +1,199 @@ + + + +# SplashScreen class + + + + + + + + + +

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) +- SplashScreen + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [mainScreenIndex](../splash_screen/SplashScreen/mainScreenIndex.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + + +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../splash_screen/SplashScreen/createState.md)() _SplashScreenState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md b/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md new file mode 100644 index 0000000000..f1eb432e83 --- /dev/null +++ b/talawa-mobile-docs/splash_screen/SplashScreen/SplashScreen.md @@ -0,0 +1,30 @@ + + + +# SplashScreen constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const SplashScreen({required Key key, this.mainScreenIndex = 0}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/splash_screen/SplashScreen/createState.md b/talawa-mobile-docs/splash_screen/SplashScreen/createState.md new file mode 100644 index 0000000000..23428f6f61 --- /dev/null +++ b/talawa-mobile-docs/splash_screen/SplashScreen/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_SplashScreenState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_SplashScreenState createState() => _SplashScreenState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/splash_screen/SplashScreen/mainScreenIndex.md b/talawa-mobile-docs/splash_screen/SplashScreen/mainScreenIndex.md new file mode 100644 index 0000000000..570058a349 --- /dev/null +++ b/talawa-mobile-docs/splash_screen/SplashScreen/mainScreenIndex.md @@ -0,0 +1,32 @@ + + + +# mainScreenIndex property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) mainScreenIndex + +_final_ + + + + + + +## Implementation + +```dart +final int mainScreenIndex; +``` + + + + + + + diff --git a/talawa-mobile-docs/splash_screen/splash_screen-library.md b/talawa-mobile-docs/splash_screen/splash_screen-library.md new file mode 100644 index 0000000000..ea4583ae68 --- /dev/null +++ b/talawa-mobile-docs/splash_screen/splash_screen-library.md @@ -0,0 +1,39 @@ + + + + +# splash_screen library + + + + + + + + + + + +## Classes + +##### [SplashScreen](../splash_screen/SplashScreen-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md new file mode 100644 index 0000000000..d54ee7ff25 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations-class.md @@ -0,0 +1,169 @@ + + + +# AppLocalizations class + + + + + + + + + +

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}) + + + + +## Properties + +##### [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_ + + + +##### [isTest](../utils_app_localization/AppLocalizations/isTest.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read / write_ + + + +##### [locale](../utils_app_localization/AppLocalizations/locale.md) → [Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) + + + + +_final_ + + + +##### [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_ + + + + + +## 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)> + + + + + + + + +##### [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)> + + + + + + + + +##### [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_ + + + +##### [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) + + + + + + + + +##### [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_ + + + +##### [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)? + + + + + + + + + + +## 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) + + + +The equality operator. +_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)? + + + + + + + + + + + +## 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)> + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md new file mode 100644 index 0000000000..bb06e087a7 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/AppLocalizations.md @@ -0,0 +1,32 @@ + + + +# AppLocalizations constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +AppLocalizations( + this.locale, { + this.isTest = false, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md new file mode 100644 index 0000000000..3725a88e1b --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/delegate-constant.md @@ -0,0 +1,33 @@ + + + +# delegate constant + + + + + + + +[LocalizationsDelegate](https://api.flutter.dev/flutter/widgets/LocalizationsDelegate-class.html)<[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)> const delegate + + + + + + + + +## Implementation + +```dart +static const LocalizationsDelegate delegate = + AppLocalizationsDelegate(); +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md new file mode 100644 index 0000000000..9f3b4dc752 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/isTest.md @@ -0,0 +1,32 @@ + + + +# isTest property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest + +_read / write_ + + + + + + +## Implementation + +```dart +bool isTest; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md new file mode 100644 index 0000000000..9cfd30ec16 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/load.md @@ -0,0 +1,46 @@ + + + +# load method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> load +() + + + + + + + + +## Implementation + +```dart +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; + + _localizedStrings = jsonMap.map((key, value) { + return MapEntry(key, value.toString()); + }); + + return true; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md new file mode 100644 index 0000000000..4f4197b060 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/loadTest.md @@ -0,0 +1,36 @@ + + + +# loadTest method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +Future loadTest(Locale locale) async { + return AppLocalizations(locale); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md new file mode 100644 index 0000000000..ba00de7965 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/locale.md @@ -0,0 +1,32 @@ + + + +# locale property + + + + + + + +[Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) locale + +_final_ + + + + + + +## Implementation + +```dart +final Locale locale; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md new file mode 100644 index 0000000000..492424bf7c --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/of.md @@ -0,0 +1,36 @@ + + + +# of method + + + + + + + + +[AppLocalizations](../../utils_app_localization/AppLocalizations-class.md)? of +([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) + + + + + + + + +## Implementation + +```dart +static AppLocalizations? of(BuildContext context) { + return Localizations.of(context, AppLocalizations); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md new file mode 100644 index 0000000000..e05a4107d4 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/strictTranslate.md @@ -0,0 +1,44 @@ + + + +# strictTranslate method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) strictTranslate +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) key) + + + + + + + + +## Implementation + +```dart +String strictTranslate(String key) { + if (isTest) return key; + + // ignore: unnecessary_null_comparison + if (key == null) { + return '...'; + } + + final String translate = _localizedStrings[key] ?? key; + return translate; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md b/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md new file mode 100644 index 0000000000..0b74121227 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizations/translate.md @@ -0,0 +1,42 @@ + + + +# translate method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? translate +([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? key) + + + + + + + + +## Implementation + +```dart +String? translate(String? key) { + if (isTest) return key; + + // ignore: unnecessary_null_comparison + if (key == null) { + return '...'; + } + return _localizedStrings[key]; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md new file mode 100644 index 0000000000..0c6f3c2d00 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate-class.md @@ -0,0 +1,150 @@ + + + +# AppLocalizationsDelegate class + + + + + + + + + + + + +**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)> +- AppLocalizationsDelegate + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [isTest](../utils_app_localization/AppLocalizationsDelegate/isTest.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Whether resources for the given locale can be loaded by this delegate. +_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)> + + + +Start loading the resources for locale. The returned future completes +when the resources have finished loading. +_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 + + + +Invoked when a non-existent method or property is accessed. +_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) + + + +Returns true if the resources for this delegate should be loaded +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md new file mode 100644 index 0000000000..3f42f908e1 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/AppLocalizationsDelegate.md @@ -0,0 +1,31 @@ + + + +# AppLocalizationsDelegate constructor + + + + + + +const +AppLocalizationsDelegate({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) + + + + + +## Implementation + +```dart +const AppLocalizationsDelegate({ + this.isTest = false, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md new file mode 100644 index 0000000000..e2529fec19 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isSupported.md @@ -0,0 +1,43 @@ + + + +# isSupported method + + + + + + + +- @[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) + +_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.

+ + + +## Implementation + +```dart +@override +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/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md new file mode 100644 index 0000000000..e6e920cdab --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/isTest.md @@ -0,0 +1,32 @@ + + + +# isTest property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest + +_final_ + + + + + + +## Implementation + +```dart +final bool isTest; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md new file mode 100644 index 0000000000..0e0684946e --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/load.md @@ -0,0 +1,52 @@ + + + +# load method + + + + + + + +- @[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) + +_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 +collection of related string resources (typically defined with one method +per resource). The object will be retrieved with Localizations.of.

+ + + +## Implementation + +```dart +@override +Future load(Locale locale) async { + // AppLocalizations class is where the JSON loading actually runs + final AppLocalizations localizations = + AppLocalizations(locale, isTest: isTest); + if (isTest) { + await localizations.loadTest(locale); + } else { + await localizations.load(); + } + + return localizations; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/shouldReload.md b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/shouldReload.md new file mode 100644 index 0000000000..232890b370 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/AppLocalizationsDelegate/shouldReload.md @@ -0,0 +1,41 @@ + + + +# shouldReload method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) shouldReload +(covariant [AppLocalizationsDelegate](../../utils_app_localization/AppLocalizationsDelegate-class.md) old) + +_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 +rebuilt. If it returns true then dependent widgets will be rebuilt +after load has completed.

+ + + +## Implementation + +```dart +@override +bool shouldReload(AppLocalizationsDelegate old) => false; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_app_localization/utils_app_localization-library.md b/talawa-mobile-docs/utils_app_localization/utils_app_localization-library.md new file mode 100644 index 0000000000..7bfdb2bfc3 --- /dev/null +++ b/talawa-mobile-docs/utils_app_localization/utils_app_localization-library.md @@ -0,0 +1,46 @@ + + + + +# app_localization library + + + + + + + + + + + +## Classes + +##### [AppLocalizations](../utils_app_localization/AppLocalizations-class.md) + + + +This class provides methods to localize the application so that it can be available +to users with different languages. + + +##### [AppLocalizationsDelegate](../utils_app_localization/AppLocalizationsDelegate-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md b/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md new file mode 100644 index 0000000000..3c20eb991d --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/ChatQueries-class.md @@ -0,0 +1,128 @@ + + + +# ChatQueries class + + + + + + + + + +

This class creates the queries dealing with chats.

+ + + + +## Constructors + +[ChatQueries](../utils_chat_queries/ChatQueries/ChatQueries.md) () + + + + +## Properties + +##### [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_ + + + +##### [messageSentToDirectChatsubscription](../utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read-only_ + + + +##### [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_ + + + + + +## 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) + + + + + + + + +##### [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) + + + + + + + + +##### [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_ + + + +##### [sendMessageToDirectChat](../utils_chat_queries/ChatQueries/sendMessageToDirectChat.md)() [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/ChatQueries/ChatQueries.md b/talawa-mobile-docs/utils_chat_queries/ChatQueries/ChatQueries.md new file mode 100644 index 0000000000..55e0facb04 --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/ChatQueries/ChatQueries.md @@ -0,0 +1,24 @@ + + + +# ChatQueries constructor + + + + + + + +ChatQueries() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md b/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md new file mode 100644 index 0000000000..c18224b70c --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatMessagesByChatId.md @@ -0,0 +1,53 @@ + + + +# fetchDirectChatMessagesByChatId method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchDirectChatMessagesByChatId +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId) + + + + + + + + +## Implementation + +```dart +String fetchDirectChatMessagesByChatId(String chatId) { + return ''' + query { + directChatsMessagesByChatID(id: "$chatId") { + _id + messageContent + sender { + _id + firstName + image + } + receiver { + _id + firstName + image + } + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md b/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md new file mode 100644 index 0000000000..37412a513b --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/ChatQueries/fetchDirectChatsByUserId.md @@ -0,0 +1,47 @@ + + + +# fetchDirectChatsByUserId method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchDirectChatsByUserId +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) + + + + + + + + +## Implementation + +```dart +String fetchDirectChatsByUserId(String userId) { + return ''' + query { + directChatsByUserID(id: "$userId") { + _id + users{ + _id + firstName + email + } + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md b/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md new file mode 100644 index 0000000000..9a57c45daf --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/ChatQueries/messageSentToDirectChatsubscription.md @@ -0,0 +1,52 @@ + + + +# messageSentToDirectChatsubscription property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) messageSentToDirectChatsubscription + + + + + + + + +## Implementation + +```dart +String get messageSentToDirectChatsubscription => ''' + subscription{ + messageSentToDirectChat{ + _id + messageContent + sender { + _id + firstName + image + } + receiver { + _id + firstName + image + } + } + } +'''; +``` + + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md b/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md new file mode 100644 index 0000000000..55f0280043 --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/ChatQueries/sendMessageToDirectChat.md @@ -0,0 +1,54 @@ + + + +# sendMessageToDirectChat method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) sendMessageToDirectChat +() + + + + + + + + +## Implementation + +```dart +String sendMessageToDirectChat() { + return ''' + mutation sendMessageToDirectChat( + \$chatId: ID! + \$messageContent: String! + ){ + sendMessageToDirectChat( + chatId: \$chatId + messageContent: \$messageContent + ) { + messageContent + sender{ + firstName + } + receiver{ + firstName + } + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_chat_queries/utils_chat_queries-library.md b/talawa-mobile-docs/utils_chat_queries/utils_chat_queries-library.md new file mode 100644 index 0000000000..6d67046a3b --- /dev/null +++ b/talawa-mobile-docs/utils_chat_queries/utils_chat_queries-library.md @@ -0,0 +1,38 @@ + + + + +# chat_queries library + + + + + + + + + + + +## Classes + +##### [ChatQueries](../utils_chat_queries/ChatQueries-class.md) + + + +This class creates the queries dealing with chats. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md b/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md new file mode 100644 index 0000000000..f321829478 --- /dev/null +++ b/talawa-mobile-docs/utils_comment_queries/CommentQueries-class.md @@ -0,0 +1,110 @@ + + + +# CommentQueries class + + + + + + + + + +

This class creates the queries dealing with comments.

+ + + + +## Constructors + +[CommentQueries](../utils_comment_queries/CommentQueries/CommentQueries.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [createComment](../utils_comment_queries/CommentQueries/createComment.md)() [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) + + + + + + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_comment_queries/CommentQueries/CommentQueries.md b/talawa-mobile-docs/utils_comment_queries/CommentQueries/CommentQueries.md new file mode 100644 index 0000000000..ce3490c524 --- /dev/null +++ b/talawa-mobile-docs/utils_comment_queries/CommentQueries/CommentQueries.md @@ -0,0 +1,24 @@ + + + +# CommentQueries constructor + + + + + + + +CommentQueries() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md b/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md new file mode 100644 index 0000000000..3557c7507e --- /dev/null +++ b/talawa-mobile-docs/utils_comment_queries/CommentQueries/createComment.md @@ -0,0 +1,46 @@ + + + +# createComment method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) createComment +() + + + + + + + + +## Implementation + +```dart +String createComment() { + return """ + mutation createComment(\$postId: ID!, \$text: String!) { + createComment(postId: \$postId, + data:{ + text: \$text, + } + ){ + _id + } + } +"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md b/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md new file mode 100644 index 0000000000..b497be68ec --- /dev/null +++ b/talawa-mobile-docs/utils_comment_queries/CommentQueries/getPostsComments.md @@ -0,0 +1,48 @@ + + + +# getPostsComments method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getPostsComments +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId) + + + + + + + + +## Implementation + +```dart +String getPostsComments(String postId) { + return """ + query{ + commentsByPost(id: "$postId"){ + _id + text + createdAt + creator{ + firstName + lastName + } + } + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_comment_queries/utils_comment_queries-library.md b/talawa-mobile-docs/utils_comment_queries/utils_comment_queries-library.md new file mode 100644 index 0000000000..9e0b120ae5 --- /dev/null +++ b/talawa-mobile-docs/utils_comment_queries/utils_comment_queries-library.md @@ -0,0 +1,38 @@ + + + + +# comment_queries library + + + + + + + + + + + +## Classes + +##### [CommentQueries](../utils_comment_queries/CommentQueries-class.md) + + + +This class creates the queries dealing with comments. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries-class.md b/talawa-mobile-docs/utils_event_queries/EventQueries-class.md new file mode 100644 index 0000000000..102d424219 --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries-class.md @@ -0,0 +1,146 @@ + + + +# EventQueries class + + + + + + + + + +

This class creates queries related to the events.

+ + + + +## Constructors + +[EventQueries](../utils_event_queries/EventQueries/EventQueries.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [addEvent](../utils_event_queries/EventQueries/addEvent.md)() [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) + + + + + + + + +##### [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) + + + + + + + + +##### [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_ + + + +##### [registerForEvent](../utils_event_queries/EventQueries/registerForEvent.md)() [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) + + + + + + + + +##### [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_ + + + +##### [updateEvent](../utils_event_queries/EventQueries/updateEvent.md)({dynamic eventId}) [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/EventQueries.md b/talawa-mobile-docs/utils_event_queries/EventQueries/EventQueries.md new file mode 100644 index 0000000000..817931179a --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/EventQueries.md @@ -0,0 +1,24 @@ + + + +# EventQueries constructor + + + + + + + +EventQueries() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md b/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md new file mode 100644 index 0000000000..d82a4ff80a --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/addEvent.md @@ -0,0 +1,71 @@ + + + +# addEvent method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) addEvent +() + + + + + + + + +## Implementation + +```dart +String addEvent() { + return """ + mutation createEvent( \$organizationId: ID!, + \$title:String!, + \$description: String!, + \$startTime: Time, + \$endTime: Time, + \$allDay: Boolean!, + \$recurring: Boolean!, + \$isPublic: Boolean!, + \$isRegisterable: Boolean!, + \$location: String, + \$startDate : Date!, + \$endDate : Date!, + ) { + createEvent( + data:{ + organizationId: \$organizationId, + title: \$title, + description: \$description, + isPublic: \$isPublic, + isRegisterable: \$isRegisterable, + recurring: \$recurring, + allDay: \$allDay, + startTime: \$startTime, + endTime: \$endTime, + startDate: \$startDate, + endDate: \$endDate, + location: \$location, + } + ){ + _id + title + description + } + } +"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md b/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md new file mode 100644 index 0000000000..fd57a07e38 --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/deleteEvent.md @@ -0,0 +1,44 @@ + + + +# deleteEvent method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) deleteEvent +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) id) + + + + + + + + +## Implementation + +```dart +String deleteEvent(String id) { + return """ + mutation { + removeEvent( + id: "$id", + ){ + _id + } + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md b/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md new file mode 100644 index 0000000000..9c6a6308f6 --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/fetchOrgEvents.md @@ -0,0 +1,72 @@ + + + +# fetchOrgEvents method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgEvents +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) + + + + + + + + +## Implementation + +```dart +String fetchOrgEvents(String orgId) { + return """ + query { + eventsByOrganization(id: "$orgId"){ + _id + organization { + _id + image + } + title + description + isPublic + isRegisterable + recurring + recurrance + startDate + endDate + allDay + startTime + endTime + location + creator{ + _id + firstName + lastName + } + admins { + firstName + lastName + } + registrants { + user { + _id + } + } + } + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md b/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md new file mode 100644 index 0000000000..c991057108 --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/registerForEvent.md @@ -0,0 +1,45 @@ + + + +# registerForEvent method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) registerForEvent +() + + + + + + + + +## Implementation + +```dart +String registerForEvent() { + return """ + mutation registerForEvent(\$eventId: ID!) { + registerForEvent(id: \$eventId) + { + _id + title + description + } + } +"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md b/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md new file mode 100644 index 0000000000..36f685036b --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/registrantsByEvent.md @@ -0,0 +1,45 @@ + + + +# registrantsByEvent method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) registrantsByEvent +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) + + + + + + + + +## Implementation + +```dart +String registrantsByEvent(String eventId) { + return ''' + query { + registrantsByEvent(id: "$eventId") { + _id + firstName + lastName + image + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md b/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md new file mode 100644 index 0000000000..3d5cf74f9b --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/EventQueries/updateEvent.md @@ -0,0 +1,67 @@ + + + +# updateEvent method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) updateEvent +({dynamic eventId}) + + + + + + + + +## Implementation + +```dart +String updateEvent({ + eventId, +}) { + return """mutation updateEvent( + \$title:String!, + \$description: String!, + \$startTime: Time, + \$endTime: Time, + \$allDay: Boolean!, + \$recurring: Boolean!, + \$isPublic: Boolean!, + \$isRegisterable: Boolean!, + \$location: String, + ) { + updateEvent( + id: "$eventId" + data:{ + title: \$title, + description: \$description, + isPublic: \$isPublic, + isRegisterable: \$isRegisterable, + recurring: \$recurring, + allDay: \$allDay, + startTime: \$startTime + endTime: \$endTime + location: \$location + } + ){ + _id + title + description + } + }"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_event_queries/utils_event_queries-library.md b/talawa-mobile-docs/utils_event_queries/utils_event_queries-library.md new file mode 100644 index 0000000000..c69f1c400d --- /dev/null +++ b/talawa-mobile-docs/utils_event_queries/utils_event_queries-library.md @@ -0,0 +1,38 @@ + + + + +# event_queries library + + + + + + + + + + + +## Classes + +##### [EventQueries](../utils_event_queries/EventQueries-class.md) + + + +This class creates queries related to the events. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/PostQueries-class.md b/talawa-mobile-docs/utils_post_queries/PostQueries-class.md new file mode 100644 index 0000000000..c42cbf66cf --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/PostQueries-class.md @@ -0,0 +1,128 @@ + + + +# PostQueries class + + + + + + + + + +

This class creates queries related to posts.

+ + + + +## Constructors + +[PostQueries](../utils_post_queries/PostQueries/PostQueries.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [addLike](../utils_post_queries/PostQueries/addLike.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +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) + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [removeLike](../utils_post_queries/PostQueries/removeLike.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +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) + + + +A string representation of this object. +_inherited_ + + + +##### [uploadPost](../utils_post_queries/PostQueries/uploadPost.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/PostQueries/PostQueries.md b/talawa-mobile-docs/utils_post_queries/PostQueries/PostQueries.md new file mode 100644 index 0000000000..6e2213d08a --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/PostQueries/PostQueries.md @@ -0,0 +1,24 @@ + + + +# PostQueries constructor + + + + + + + +PostQueries() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md b/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md new file mode 100644 index 0000000000..75f191c97a --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/PostQueries/addLike.md @@ -0,0 +1,50 @@ + + + +# addLike method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +String addLike() { + return """ + mutation likePost(\$postID: ID!) { + likePost( id: \$postID,) + { + _id + } + } +"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md b/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md new file mode 100644 index 0000000000..ed6fb741cd --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/PostQueries/getPostsById.md @@ -0,0 +1,74 @@ + + + +# getPostsById method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +String getPostsById(String orgId) { + return """ + query { + postsByOrganization(id: "$orgId",orderBy: createdAt_DESC ) + { + _id + text + createdAt + imageUrl + videoUrl + title + commentCount + likeCount + creator{ + _id + firstName + lastName + image + } + organization{ + _id + } + likedBy{ + _id + } + comments{ + _id + } + } + } +"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md b/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md new file mode 100644 index 0000000000..e43f174fcd --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/PostQueries/removeLike.md @@ -0,0 +1,53 @@ + + + +# removeLike method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +String removeLike() { + return """ + mutation unlikePost(\$postID: ID!) { + unlikePost( id: \$postID,) + { + _id + likedBy{ + _id + } + } + } +"""; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md b/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md new file mode 100644 index 0000000000..59d03b867d --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/PostQueries/uploadPost.md @@ -0,0 +1,63 @@ + + + +# uploadPost method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +String uploadPost() { + return ''' + mutation CreatePost( + \$text: String! + \$title: String! + \$imageUrl: URL + \$videoUrl: URL + \$organizationId: ID! +) { + createPost( + data: { + text: \$text + title: \$title + imageUrl: \$imageUrl + videoUrl: \$videoUrl + organizationId: \$organizationId + } + ) { + _id + } +} + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_post_queries/utils_post_queries-library.md b/talawa-mobile-docs/utils_post_queries/utils_post_queries-library.md new file mode 100644 index 0000000000..b2562cc700 --- /dev/null +++ b/talawa-mobile-docs/utils_post_queries/utils_post_queries-library.md @@ -0,0 +1,38 @@ + + + + +# post_queries library + + + + + + + + + + + +## Classes + +##### [PostQueries](../utils_post_queries/PostQueries-class.md) + + + +This class creates queries related to posts. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries-class.md b/talawa-mobile-docs/utils_queries/Queries-class.md new file mode 100644 index 0000000000..7b1fc116fe --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries-class.md @@ -0,0 +1,245 @@ + + + +# Queries class + + + + + + + + + +

This class returns some queries for the application.

+ + + + +## Constructors + +[Queries](../utils_queries/Queries/Queries.md) () + + + + +## Properties + +##### [fetchJoinInOrg](../utils_queries/Queries/fetchJoinInOrg.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read-only_ + + + +##### [fetchJoinInOrgByName](../utils_queries/Queries/fetchJoinInOrgByName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read-only_ + + + +##### [fetchUserInfo](../utils_queries/Queries/fetchUserInfo.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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 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) + + + + + + + + +##### [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) + + + + + + + + +##### [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 + + + + +##### [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) + + + + + + + + +##### [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) + + + + + + + + +##### [logout](../utils_queries/Queries/logout.md)() [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) + + + + + + + + +##### [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_ + + + +##### [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) + + + + + + + + +##### [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) + + + + + + + + +##### [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) + + + + + + + + +##### [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) + + + + + + + + +##### [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_ + + + +##### [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) + + + + + + + + +##### [userLanguage](../utils_queries/Queries/userLanguage.md)() [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/Queries.md b/talawa-mobile-docs/utils_queries/Queries/Queries.md new file mode 100644 index 0000000000..b256076324 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/Queries.md @@ -0,0 +1,24 @@ + + + +# Queries constructor + + + + + + + +Queries() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/createDonation.md b/talawa-mobile-docs/utils_queries/Queries/createDonation.md new file mode 100644 index 0000000000..3aed8b44ee --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/createDonation.md @@ -0,0 +1,61 @@ + + + +# createDonation method + + + + + + + + +[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

+ + + +## Implementation + +```dart +String createDonation( + String userId, + String orgId, + String nameOfOrg, + String nameOfUser, + String payPalId, + double amount, +) { + return ''' + mutation createDonationMutation { createDonation( + userId :"$userId" + orgId :"$orgId", + nameOfOrg:"$nameOfOrg", + nameOfUser:"$nameOfUser", + payPalId:"$payPalId" + amount :$amount + ){ + _id + payPalId + userId + orgId + payPalId + nameOfUser + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md b/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md new file mode 100644 index 0000000000..33bb1607af --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrg.md @@ -0,0 +1,55 @@ + + + +# fetchJoinInOrg property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchJoinInOrg + + + + + + + + +## Implementation + +```dart +String get fetchJoinInOrg { + return """ + query organizationsConnection(\$first: Int, \$skip: Int){ + organizationsConnection( + first: \$first, + skip: \$skip, + orderBy: name_ASC + ){ + image + _id + name + image + isPublic + creator{ + firstName + lastName + } + } + } +"""; +} +``` + + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md b/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md new file mode 100644 index 0000000000..02bcbb6172 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/fetchJoinInOrgByName.md @@ -0,0 +1,64 @@ + + + +# fetchJoinInOrgByName property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchJoinInOrgByName + + + + + + + + +## Implementation + +```dart +String get fetchJoinInOrgByName { + return """ + query organizationsConnection( + \$first: Int, + \$skip: Int, + \$nameStartsWith: String + ){ + organizationsConnection( + where:{ + name_starts_with: \$nameStartsWith, + visibleInSearch: true, + isPublic: true, + } + first: \$first, + skip: \$skip, + orderBy: name_ASC + ){ + image + _id + name + image + isPublic + creator{ + firstName + lastName + } + } + } +"""; +} +``` + + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md b/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md new file mode 100644 index 0000000000..ea2c109b2d --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/fetchOrgById.md @@ -0,0 +1,50 @@ + + + +# fetchOrgById method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgById +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) + + + + + + + + +## Implementation + +```dart +String fetchOrgById(String orgId) { + return ''' + query{ + organizations(id: "$orgId"){ + image + _id + name + image + isPublic + creator{ + firstName + lastName + } + } + } +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md b/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md new file mode 100644 index 0000000000..f311d621c1 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/fetchOrgDetailsById.md @@ -0,0 +1,60 @@ + + + +# fetchOrgDetailsById method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchOrgDetailsById +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) + + + + + + + + +## Implementation + +```dart +String fetchOrgDetailsById(String orgId) { + return ''' + query{ + organizations(id: "$orgId"){ + image + _id + name + admins{ + _id + } + description + isPublic + creator{ + _id + firstName + lastName + } + members{ + _id + firstName + lastName + image + } + } + } +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md b/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md new file mode 100644 index 0000000000..c038293e52 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/fetchUserInfo.md @@ -0,0 +1,86 @@ + + + +# fetchUserInfo property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fetchUserInfo + +_read / write_ + + + + + + +## Implementation + +```dart +String fetchUserInfo = ''' + query Users(\$id: ID!){ + users(where: { id: \$id }) { + _id + firstName + lastName + email + image + joinedOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + + } + createdOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + membershipRequests{ + organization{ + _id + name + image + isPublic + creator{ + _id + firstName + lastName + image + } + } + } + adminFor{ + _id + } + } + } + '''; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md b/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md new file mode 100644 index 0000000000..66e39ef684 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/getPluginsList.md @@ -0,0 +1,48 @@ + + + +# getPluginsList method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getPluginsList +() + + + + + +

getPluginList queries all properties of pluginList from the server

+ + + +## Implementation + +```dart +String getPluginsList() { + return ''' +query { +getPlugins { + _id + pluginName + pluginCreatedBy + pluginDesc + pluginInstallStatus + installedOrgs +} +} +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md b/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md new file mode 100644 index 0000000000..6b3a9c800c --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/joinOrgById.md @@ -0,0 +1,55 @@ + + + +# joinOrgById method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) joinOrgById +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) + + + + + + + + +## Implementation + +```dart +String joinOrgById(String orgId) { + return ''' + mutation { + joinPublicOrganization(organizationId: "$orgId") { + joinedOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + + } + } + } +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/loginUser.md b/talawa-mobile-docs/utils_queries/Queries/loginUser.md new file mode 100644 index 0000000000..31a470855f --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/loginUser.md @@ -0,0 +1,110 @@ + + + +# loginUser method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +String loginUser(String email, String password) { + return """ + mutation { + login(data: {email: "$email", password: "$password"}){ + accessToken + user{ + _id + firstName + lastName + email + image + joinedOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + createdOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + membershipRequests{ + organization{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + } + adminFor{ + _id + } + } + refreshToken + androidFirebaseOptions { + apiKey + appId + messagingSenderId + projectId + storageBucket + } + iosFirebaseOptions { + apiKey + appId + messagingSenderId + projectId + storageBucket + iosClientId + iosBundleId + } + } + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/logout.md b/talawa-mobile-docs/utils_queries/Queries/logout.md new file mode 100644 index 0000000000..673bb38856 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/logout.md @@ -0,0 +1,40 @@ + + + +# logout method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) logout +() + + + + + + + + +## Implementation + +```dart +String logout() { + return """ + mutation { + logout + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md b/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md new file mode 100644 index 0000000000..a22689f7d2 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/newUserLanguage.md @@ -0,0 +1,40 @@ + + + +# newUserLanguage method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) newUserLanguage +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) + + + + + + + + +## Implementation + +```dart +String newUserLanguage(String userId) { + return ''' + query{ + userLanguage(userId:"$userId") + } +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/refreshToken.md b/talawa-mobile-docs/utils_queries/Queries/refreshToken.md new file mode 100644 index 0000000000..c384ab0919 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/refreshToken.md @@ -0,0 +1,43 @@ + + + +# refreshToken method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) refreshToken) + + + + + + + + +## Implementation + +```dart +String refreshToken(String refreshToken) { + return ''' + mutation{ + refreshToken(refreshToken: "$refreshToken"){ + accessToken + refreshToken + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/registerUser.md b/talawa-mobile-docs/utils_queries/Queries/registerUser.md new file mode 100644 index 0000000000..19b4402c66 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/registerUser.md @@ -0,0 +1,100 @@ + + + +# registerUser method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +String registerUser( + String firstName, + String lastName, + String email, + String password, +) { + return """ + mutation{ + signUp(data: {firstName: "$firstName", lastName: "$lastName", email: "$email", password: "$password"}) + { + accessToken + user{ + _id + firstName + lastName + email + image + joinedOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + createdOrganizations{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + membershipRequests{ + organization{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + } + adminFor{ + _id + } + } + refreshToken + } + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md b/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md new file mode 100644 index 0000000000..0b8bab769c --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/saveFcmToken.md @@ -0,0 +1,40 @@ + + + +# saveFcmToken method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) saveFcmToken +([String](https://api.flutter.dev/flutter/dart-core/String-class.html)? token) + + + + + + + + +## Implementation + +```dart +String saveFcmToken(String? token) { + return """ + mutation { + saveFcmToken(token: "$token") + } + """; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md b/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md new file mode 100644 index 0000000000..033475b2b7 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/sendMembershipRequest.md @@ -0,0 +1,54 @@ + + + +# sendMembershipRequest method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) sendMembershipRequest +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId) + + + + + + + + +## Implementation + +```dart +String sendMembershipRequest(String orgId) { + return ''' + mutation { + sendMembershipRequest(organizationId: "$orgId"){ + organization{ + _id + name + image + description + isPublic + creator{ + _id + firstName + lastName + image + } + } + } + } +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md b/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md new file mode 100644 index 0000000000..4f786b799c --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/updateLanguage.md @@ -0,0 +1,44 @@ + + + +# updateLanguage method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) updateLanguage +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) languageCode) + + + + + + + + +## Implementation + +```dart +String updateLanguage(String languageCode) { + return ''' + mutation { + updateLanguage(languageCode: "$languageCode"){ + _id + firstName + appLanguageCode + } + } + '''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/Queries/userLanguage.md b/talawa-mobile-docs/utils_queries/Queries/userLanguage.md new file mode 100644 index 0000000000..7e07be5a62 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/Queries/userLanguage.md @@ -0,0 +1,40 @@ + + + +# userLanguage method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userLanguage +() + + + + + + + + +## Implementation + +```dart +String userLanguage() { + return ''' + query{ + myLanguage + } +'''; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_queries/utils_queries-library.md b/talawa-mobile-docs/utils_queries/utils_queries-library.md new file mode 100644 index 0000000000..79e7d49e67 --- /dev/null +++ b/talawa-mobile-docs/utils_queries/utils_queries-library.md @@ -0,0 +1,38 @@ + + + + +# queries library + + + + + + + + + + + +## Classes + +##### [Queries](../utils_queries/Queries-class.md) + + + +This class returns some queries for the application. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md b/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md new file mode 100644 index 0000000000..9c6198bcd9 --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries-class.md @@ -0,0 +1,139 @@ + + + +# TaskQueries class + + + + + + + + + +

This class creates queries for the tasks in the application.

+ + + + +## Constructors + +[TaskQueries](../utils_task_queries/TaskQueries/TaskQueries.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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) + + + + + + + + +##### [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) + + + + + + + + +##### [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) + + + + + + + + +##### [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) + + + + + + + + +##### [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/talawa-mobile-docs/utils_task_queries/TaskQueries/TaskQueries.md b/talawa-mobile-docs/utils_task_queries/TaskQueries/TaskQueries.md new file mode 100644 index 0000000000..aa01fdd0c1 --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries/TaskQueries.md @@ -0,0 +1,24 @@ + + + +# TaskQueries constructor + + + + + + + +TaskQueries() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md b/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md new file mode 100644 index 0000000000..9152376d4f --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries/addTask.md @@ -0,0 +1,61 @@ + + + +# addTask method + + + + + + + + +[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}) + + + + + + + + +## Implementation + +```dart +static String addTask({ + required String title, + required String description, + required String deadline, + required String eventId, +}) => + ''' + mutation { + createTask( + data: { title: "$title", description: "$description", deadline: "$deadline" } + eventId: "$eventId" + ) { + _id + title + description + createdAt + deadline + creator { + _id + firstName + } + event { + _id + title + } + } + } + '''; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md b/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md new file mode 100644 index 0000000000..6c2ee6db38 --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries/deleteTask.md @@ -0,0 +1,40 @@ + + + +# deleteTask method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) deleteTask +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) taskId) + + + + + + + + +## Implementation + +```dart +static String deleteTask(String taskId) => ''' + mutation { + removeTask(id: "$taskId") { + _id + } + } +'''; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md b/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md new file mode 100644 index 0000000000..f176f847ff --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries/editTask.md @@ -0,0 +1,59 @@ + + + +# editTask method + + + + + + + + +[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}) + + + + + + + + +## Implementation + +```dart +static String editTask({ + required String title, + required String description, + required String deadline, + required String taskId, +}) => + ''' + mutation { + updateTask( + data: { title: "$title", description: "$description", deadline: "$deadline" } + id: "$taskId" + ) { + _id + title + description + createdAt + deadline + creator { + _id + } + event { + _id + } + } + } + '''; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md b/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md new file mode 100644 index 0000000000..4b5260c941 --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries/eventTasks.md @@ -0,0 +1,52 @@ + + + +# eventTasks method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventTasks +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId) + + + + + + + + +## Implementation + +```dart +static String eventTasks(String eventId) => ''' + query { + tasksByEvent(id: "$eventId") { + _id + title + description + createdAt + deadline + creator { + _id + firstName + } + event { + _id + title + } + } + } +'''; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md b/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md new file mode 100644 index 0000000000..0c3064b19f --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/TaskQueries/userTasks.md @@ -0,0 +1,52 @@ + + + +# userTasks method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userTasks +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) userId) + + + + + + + + +## Implementation + +```dart +static String userTasks(String userId) => ''' + query { + tasksByUser(id: "$userId") { + _id + title + description + createdAt + deadline + creator { + _id + firstName + } + event { + _id + title + } + } + } +'''; +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_task_queries/utils_task_queries-library.md b/talawa-mobile-docs/utils_task_queries/utils_task_queries-library.md new file mode 100644 index 0000000000..b1fba2dedb --- /dev/null +++ b/talawa-mobile-docs/utils_task_queries/utils_task_queries-library.md @@ -0,0 +1,38 @@ + + + + +# task_queries library + + + + + + + + + + + +## Classes + +##### [TaskQueries](../utils_task_queries/TaskQueries-class.md) + + + +This class creates queries for the tasks in the application. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator-class.md b/talawa-mobile-docs/utils_validators/Validator-class.md new file mode 100644 index 0000000000..f179f31a12 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator-class.md @@ -0,0 +1,167 @@ + + + +# Validator class + + + + + + + + + +

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

+ + + + +## Constructors + +[Validator](../utils_validators/Validator/Validator.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + +##### [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)?> + + + + + + + + + + +## 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) + + + +The equality operator. +_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)? + + + + + + + + +##### [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)? + + + + + + + + +##### [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)? + + + + + + + + +##### [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)? + + + + + + + + +##### [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)? + + + + + + + + +##### [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)? + + + + + + + + +##### [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/talawa-mobile-docs/utils_validators/Validator/Validator.md b/talawa-mobile-docs/utils_validators/Validator/Validator.md new file mode 100644 index 0000000000..4aa170cc1a --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/Validator.md @@ -0,0 +1,24 @@ + + + +# Validator constructor + + + + + + + +Validator() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validateEmail.md b/talawa-mobile-docs/utils_validators/Validator/validateEmail.md new file mode 100644 index 0000000000..b167aec826 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validateEmail.md @@ -0,0 +1,48 @@ + + + +# validateEmail method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateEmail +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) email) + + + + + + + + +## Implementation + +```dart +static String? validateEmail( + String email, +) { + // 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])?)*$"; + final RegExp regex = RegExp(pattern); + if (!regex.hasMatch(email)) { + return 'Please enter a valid Email Address'; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md b/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md new file mode 100644 index 0000000000..2742c92773 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validateEventForm.md @@ -0,0 +1,45 @@ + + + +# validateEventForm method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +static String? validateEventForm(String value, String? label) { + if (value.isEmpty) { + return '$label must not be left blank.'; + } + // ignore: unnecessary_raw_strings + const String pattern = r'(?=.*?[A-Za-z]).+'; + final RegExp regex = RegExp(pattern); + if (!regex.hasMatch(value)) { + return "Invalid $label"; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md b/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md new file mode 100644 index 0000000000..bef755da68 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validateFirstName.md @@ -0,0 +1,45 @@ + + + +# validateFirstName method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateFirstName +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) + + + + + + + + +## Implementation + +```dart +static String? validateFirstName(String value) { + if (value.isEmpty) { + return 'Firstname must not be left blank.'; + } + // ignore: unnecessary_raw_strings + const String pattern = r'(?=.*?[A-Za-z]).+'; + final RegExp regex = RegExp(pattern); + if (!regex.hasMatch(value)) { + return "Invalid Firstname"; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validateLastName.md b/talawa-mobile-docs/utils_validators/Validator/validateLastName.md new file mode 100644 index 0000000000..d0f24762f3 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validateLastName.md @@ -0,0 +1,45 @@ + + + +# validateLastName method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateLastName +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) + + + + + + + + +## Implementation + +```dart +static String? validateLastName(String value) { + if (value.isEmpty) { + return 'Lastname must not be left blank.'; + } + // ignore: unnecessary_raw_strings + const String pattern = r"(?=.*?[A-Za-z]).+"; + final RegExp regex = RegExp(pattern); + if (!regex.hasMatch(value)) { + return "Invalid Lastname"; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validatePassword.md b/talawa-mobile-docs/utils_validators/Validator/validatePassword.md new file mode 100644 index 0000000000..f79ec49c78 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validatePassword.md @@ -0,0 +1,57 @@ + + + +# validatePassword method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validatePassword +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) password) + + + + + + + + +## Implementation + +```dart +static String? validatePassword( + String password, +) { + // If password is empty return. + if (password.isEmpty) { + return "Password must not be left blank"; + } + const String pattern = + r'^(?=.*?[A-Z])(?=.*?[0-9])(?=.*?[!@#\$&*%^~.]).{8,}$'; + final RegExp regExp = RegExp(pattern); + + //Regex for no spaces allowed + const String noSpaces = r'^\S+$'; + final RegExp noSpaceRegex = RegExp(noSpaces); + + if (!noSpaceRegex.hasMatch(password)) { + return "Password must not contain spaces"; + } + 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/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md b/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md new file mode 100644 index 0000000000..aa89e2f44b --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validatePasswordConfirm.md @@ -0,0 +1,42 @@ + + + +# validatePasswordConfirm method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +static String? validatePasswordConfirm( + String value, + String comparator, +) { + if (value != comparator) { + return 'Password does not match original'; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validateURL.md b/talawa-mobile-docs/utils_validators/Validator/validateURL.md new file mode 100644 index 0000000000..b1608f917d --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validateURL.md @@ -0,0 +1,45 @@ + + + +# validateURL method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? validateURL +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) value) + + + + + + + + +## Implementation + +```dart +static String? validateURL( + String value, +) { + if (value.isEmpty) { + return 'Please verify URL first'; + } + final bool validURL = Uri.parse(value).isAbsolute; + if (!validURL) { + return 'Enter a valid URL'; + } + return null; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md b/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md new file mode 100644 index 0000000000..568b5ec31e --- /dev/null +++ b/talawa-mobile-docs/utils_validators/Validator/validateUrlExistence.md @@ -0,0 +1,42 @@ + + + +# validateUrlExistence method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +Future validateUrlExistence(String url) async { + try { + await http.get(Uri.parse(url)); + return true; + } on Exception catch (e) { + debugPrint(e.toString()); + return false; + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/utils_validators/utils_validators-library.md b/talawa-mobile-docs/utils_validators/utils_validators-library.md new file mode 100644 index 0000000000..e19c39fe84 --- /dev/null +++ b/talawa-mobile-docs/utils_validators/utils_validators-library.md @@ -0,0 +1,39 @@ + + + + +# validators library + + + + + + + + + + + +## Classes + +##### [Validator](../utils_validators/Validator-class.md) + + + +This class creats various validator methods for the application. +They are used to validate information given by the users. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md new file mode 100644 index 0000000000..dcb8604eac --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel-class.md @@ -0,0 +1,233 @@ + + + +# AccessScreenViewModel class + + + + + + + + + + + + +**Inheritance** + +- [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 + + + + + + + + +## Constructors + +[AccessScreenViewModel](../view_model_access_request_view_model/AccessScreenViewModel/AccessScreenViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [optionalMessageController](../view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md) → [TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) + + + + +_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)> + + + + +_read / write_ + + + +##### [orgId](../view_model_access_request_view_model/AccessScreenViewModel/orgId.md) ↔ [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [selectedOrganization](../view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_read / write_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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> + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [sendMembershipRequest](../view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + + + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/AccessScreenViewModel.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/AccessScreenViewModel.md new file mode 100644 index 0000000000..0679943869 --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/AccessScreenViewModel.md @@ -0,0 +1,24 @@ + + + +# AccessScreenViewModel constructor + + + + + + + +AccessScreenViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md new file mode 100644 index 0000000000..7bb061c66b --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/initialise.md @@ -0,0 +1,36 @@ + + + +# initialise method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org) + + + + + + + + +## Implementation + +```dart +Future initialise(OrgInfo org) async { + selectedOrganization = org; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md new file mode 100644 index 0000000000..3feae3226d --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/optionalMessageController.md @@ -0,0 +1,32 @@ + + + +# optionalMessageController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) optionalMessageController + +_final_ + + + + + + +## Implementation + +```dart +final optionalMessageController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md new file mode 100644 index 0000000000..8401c3532a --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/orgId.md @@ -0,0 +1,32 @@ + + + +# orgId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId + +_read / write_ + + + + + + +## Implementation + +```dart +late String orgId; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md new file mode 100644 index 0000000000..d267d675bd --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/organizations.md @@ -0,0 +1,32 @@ + + + +# organizations property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> organizations + +_read / write_ + + + + + + +## Implementation + +```dart +late List organizations = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md new file mode 100644 index 0000000000..1c7a65ca8a --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/selectedOrganization.md @@ -0,0 +1,32 @@ + + + +# selectedOrganization property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrganization + +_read / write_ + + + + + + +## Implementation + +```dart +late OrgInfo selectedOrganization = OrgInfo(id: '-1'); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md new file mode 100644 index 0000000000..badfa2c33d --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/AccessScreenViewModel/sendMembershipRequest.md @@ -0,0 +1,58 @@ + + + +# sendMembershipRequest method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> sendMembershipRequest +() + + + + + + + + +## Implementation + +```dart +Future sendMembershipRequest() async { + //TODO: Implement Message arg for below function + final result = await databaseFunctions.gqlAuthMutation( + queries.sendMembershipRequest(selectedOrganization.id!), + ); + if (result != null) { + final OrgInfo membershipRequest = OrgInfo.fromJson( + (((result as QueryResult).data!)['sendMembershipRequest'] + as Map)['organization'] as Map, + ); + userConfig.updateUserMemberRequestOrg([membershipRequest]); + if (userConfig.currentUser.joinedOrganizations!.isEmpty) { + navigationService.removeAllAndPush( + Routes.waitingScreen, + Routes.splashScreen, + ); + } else { + navigationService.pop(); + navigationService.showTalawaErrorSnackBar( + 'Join in request sent to ${selectedOrganization.name} successfully', + MessageType.info, + ); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_access_request_view_model/view_model_access_request_view_model-library.md b/talawa-mobile-docs/view_model_access_request_view_model/view_model_access_request_view_model-library.md new file mode 100644 index 0000000000..4f6d0332cd --- /dev/null +++ b/talawa-mobile-docs/view_model_access_request_view_model/view_model_access_request_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# access_request_view_model library + + + + + + + + + + + +## Classes + +##### [AccessScreenViewModel](../view_model_access_request_view_model/AccessScreenViewModel-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md new file mode 100644 index 0000000000..d1cf1ebe11 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md @@ -0,0 +1,262 @@ + + + +# AddPostViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- AddPostViewModel + + + + + + + + +## Constructors + +[AddPostViewModel](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/AddPostViewModel.md) () + + + + +## 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) + + + +Post body text controller. +_read-only_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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> + + + +This function is used to get the image from gallery. + + + + +##### [initialise](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md)() void + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [removeImage](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md)() void + + + +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 + + + +Remove a previously registered closure from the list of closures that are +notified when the object changes. +_inherited_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + +##### [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> + + + +This function uploads the post finally, and navigate the success message or error message in Snack Bar. + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/AddPostViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/AddPostViewModel.md new file mode 100644 index 0000000000..3c75d173a7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/AddPostViewModel.md @@ -0,0 +1,24 @@ + + + +# AddPostViewModel constructor + + + + + + + +AddPostViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md new file mode 100644 index 0000000000..6bfa5f1a3e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/controller.md @@ -0,0 +1,42 @@ + + + +# controller property + + + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) controller + + + + + +

Post body text controller.

+

params: +None +returns:

+
    +
  • TextEditingController: The main text controller of the post body
  • +
+ + + +## Implementation + +```dart +TextEditingController get controller => _controller; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md new file mode 100644 index 0000000000..4b687e6e28 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/getImageFromGallery.md @@ -0,0 +1,55 @@ + + + +# getImageFromGallery method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future getImageFromGallery({bool camera = false}) async { + final image = + await _multiMediaPickerService.getPhotoFromGallery(camera: camera); + if (image != null) { + _imageFile = image; + _navigationService.showTalawaErrorSnackBar( + "Image is added", + MessageType.info, + ); + notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md new file mode 100644 index 0000000000..19699241f8 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/imageFile.md @@ -0,0 +1,42 @@ + + + +# imageFile property + + + + + + + + + +[File](https://api.flutter.dev/flutter/dart-io/File-class.html)? imageFile + + + + + +

The image file that is to be uploaded.

+

params: +None +returns:

+
    +
  • File?: The image file
  • +
+ + + +## Implementation + +```dart +File? get imageFile => _imageFile; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md new file mode 100644 index 0000000000..ab0e08b7e4 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/initialise.md @@ -0,0 +1,46 @@ + + + +# initialise method + + + + + + + + +void initialise +() + + + + + +

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; + _imageFile = null; + _multiMediaPickerService = locator(); + _dbFunctions = locator(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md new file mode 100644 index 0000000000..1006f77686 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/orgName.md @@ -0,0 +1,42 @@ + + + +# orgName property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgName + + + + + +

The organisation name.

+

params: +None +returns:

+
    +
  • String: The organisation name
  • +
+ + + +## Implementation + +```dart +String get orgName => _selectedOrg.name!; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md new file mode 100644 index 0000000000..43fd648c64 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/removeImage.md @@ -0,0 +1,42 @@ + + + +# removeImage method + + + + + + + + +void removeImage +() + + + + + +

This function removes the image selected.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void removeImage() { + _imageFile = null; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md new file mode 100644 index 0000000000..d3fac7285a --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/titleController.md @@ -0,0 +1,42 @@ + + + +# titleController property + + + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) titleController + + + + + +

Post title text controller.

+

params: +None +returns:

+
    +
  • TextEditingController: The text controller of the title body
  • +
+ + + +## Implementation + +```dart +TextEditingController get titleController => _titleController; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md new file mode 100644 index 0000000000..4fc93630b5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/uploadPost.md @@ -0,0 +1,68 @@ + + + +# uploadPost method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future uploadPost() async { + // {TODO: } + if (_imageFile == null) { + try { + await _dbFunctions.gqlAuthMutation( + PostQueries().uploadPost(), + variables: { + "text": _controller.text, + "organizationId": _selectedOrg.id, + "title": _titleController.text + }, + ); + _navigationService.showTalawaErrorSnackBar( + "Post is uploaded", + MessageType.info, + ); + } on Exception catch (_) { + _navigationService.showTalawaErrorSnackBar( + "Something went wrong", + MessageType.error, + ); + } + } + removeImage(); + _controller.text = ""; + _titleController.text = ""; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md new file mode 100644 index 0000000000..91033806d0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel/userName.md @@ -0,0 +1,42 @@ + + + +# userName property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userName + + + + + +

The Username.

+

params: +None +returns:

+
    +
  • String: The username of the currentUser
  • +
+ + + +## Implementation + +```dart +String get userName => _currentUser.firstName! + _currentUser.lastName!; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/view_model_after_auth_view_models_add_post_view_models_add_post_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/view_model_after_auth_view_models_add_post_view_models_add_post_view_model-library.md new file mode 100644 index 0000000000..abcf04d8d5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_add_post_view_models_add_post_view_model/view_model_after_auth_view_models_add_post_view_models_add_post_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# add_post_view_model library + + + + + + + + + + + +## Classes + +##### [AddPostViewModel](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md) + + + +AddPostViewModel class have different functions that are used. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md new file mode 100644 index 0000000000..ba22f8b88f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md @@ -0,0 +1,276 @@ + + + +# DirectChatViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- DirectChatViewModel + + + + + + + + +## Constructors + +[DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/DirectChatViewModel.md) () + + + + +## 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)>> + + + + +_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)> + + + + +_read-only_ + + + +##### [chatState](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md) ↔ [ChatState](../enums_enums/ChatState.md) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [chatName](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md)(dynamic chatId) void + + + + + + + + +##### [dispose](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md)() 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). +_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> + + + +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> + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [refreshChats](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md)() void + + + +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 + + + +Remove a previously registered closure from the list of closures that are +notified when the object changes. +_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> + + + +This function send the message to Direct Chat. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/DirectChatViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/DirectChatViewModel.md new file mode 100644 index 0000000000..04646cdf50 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/DirectChatViewModel.md @@ -0,0 +1,24 @@ + + + +# DirectChatViewModel constructor + + + + + + + +DirectChatViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md new file mode 100644 index 0000000000..77f46270e0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatMessagesByUser.md @@ -0,0 +1,35 @@ + + + +# chatMessagesByUser property + + + + + + + + + +[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 + + + + + + + + +## Implementation + +```dart +Map> get chatMessagesByUser => _chatMessagesByUser; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md new file mode 100644 index 0000000000..5c2f3625b4 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatName.md @@ -0,0 +1,43 @@ + + + +# chatName method + + + + + + + + +void chatName +(dynamic chatId) + + + + + + + + +## Implementation + +```dart +void chatName(chatId) { + final List users = + _chats.firstWhere((element) => element.id == chatId).users!; + + users.forEach((element) { + if (element.id != userConfig.currentUser.id!) { + name = element.firstName; + } + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md new file mode 100644 index 0000000000..0ebdda61c9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chatState.md @@ -0,0 +1,32 @@ + + + +# chatState property + + + + + + + +[ChatState](../../enums_enums/ChatState.md) chatState + +_read / write_ + + + + + + +## Implementation + +```dart +ChatState chatState = ChatState.initial; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md new file mode 100644 index 0000000000..81f69657a5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/chats.md @@ -0,0 +1,35 @@ + + + +# chats property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md)> chats + + + + + + + + +## Implementation + +```dart +List get chats => _chats; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md new file mode 100644 index 0000000000..551ec7916f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/dispose.md @@ -0,0 +1,47 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_override_ + + + +

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 +it is called. Consumers of this class must decide on whether to notify +listeners or not immediately before disposal.

+ + + +## Implementation + +```dart +@override +void dispose() { + _chatMessageSubscription?.cancel(); + _chatListSubscription.cancel(); + super.dispose(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md new file mode 100644 index 0000000000..bf87af3bc9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/getChatMessages.md @@ -0,0 +1,54 @@ + + + +# getChatMessages method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future getChatMessages(String chatId) async { + _chatMessagesByUser.clear(); + chatState = ChatState.loading; + // await _chatService.getMessagesFromDirectChat(); + // variable + final List messages = []; + _chatMessageSubscription = + _chatService.chatMessagesStream.listen((newMessage) { + messages.add(newMessage); + _chatMessagesByUser[chatId] = messages; + }); + // use `chatService` services + await _chatService.getDirectChatMessagesByChatId(chatId); + chatState = ChatState.complete; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md new file mode 100644 index 0000000000..1ddffc5e03 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/initialise.md @@ -0,0 +1,47 @@ + + + +# initialise method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +() + + + + + + + + +## Implementation + +```dart +Future initialise() async { + setState(ViewState.busy); + chatState = ChatState.loading; + + _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/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md new file mode 100644 index 0000000000..64ba84797b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/listKey.md @@ -0,0 +1,32 @@ + + + +# listKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[AnimatedListState](https://api.flutter.dev/flutter/widgets/AnimatedListState-class.html)> listKey + +_final_ + + + + + + +## Implementation + +```dart +final listKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md new file mode 100644 index 0000000000..8a9acbd902 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/name.md @@ -0,0 +1,32 @@ + + + +# name property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? name + +_read / write_ + + + + + + +## Implementation + +```dart +String? name; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md new file mode 100644 index 0000000000..87d21035e8 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/refreshChats.md @@ -0,0 +1,40 @@ + + + +# refreshChats method + + + + + + + + +void refreshChats +() + + + + + +

This function refresh the chats.

+ + + +## Implementation + +```dart +void refreshChats() { + _chats.clear(); + _uniqueChatIds.clear(); + notifyListeners(); + _chatService.getDirectChatsByUserId(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md new file mode 100644 index 0000000000..d1cf19519b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel/sendMessageToDirectChat.md @@ -0,0 +1,50 @@ + + + +# sendMessageToDirectChat method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future sendMessageToDirectChat( + String chatId, + String messageContent, +) async { + chatState = ChatState.loading; + _chatService.chatMessagesStream.listen((newMessage) { + _chatMessagesByUser[chatId]!.add(newMessage); + }); + await _chatService.sendMessageToDirectChat(chatId, messageContent); + chatState = ChatState.complete; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model-library.md new file mode 100644 index 0000000000..e1737c8bbb --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/view_model_after_auth_view_models_chat_view_models_direct_chat_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# direct_chat_view_model library + + + + + + + + + + + +## Classes + +##### [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) + + + +This ViewModel class have different functions that are used interact with model in the context of Direct Chat. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md new file mode 100644 index 0000000000..d1b8cd05b9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md @@ -0,0 +1,211 @@ + + + +# SelectContactViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- SelectContactViewModel + + + + + + + + +## Constructors + +[SelectContactViewModel](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/SelectContactViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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> + + + +This function is used to get all users list of an current organization. + + + + +##### [initialise](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md)() void + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/SelectContactViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/SelectContactViewModel.md new file mode 100644 index 0000000000..195db77ac0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/SelectContactViewModel.md @@ -0,0 +1,24 @@ + + + +# SelectContactViewModel constructor + + + + + + + +SelectContactViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md new file mode 100644 index 0000000000..8c9f8c8cd2 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/getCurrentOrgUsersList.md @@ -0,0 +1,42 @@ + + + +# getCurrentOrgUsersList method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future getCurrentOrgUsersList() async { + if (orgMembersList.isEmpty) { + orgMembersList = await _organizationService + .getOrgMembersList(userConfig.currentOrg.id!); + } + + //return orgMembersList; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md new file mode 100644 index 0000000000..a51657cbb6 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/initialise.md @@ -0,0 +1,36 @@ + + + +# initialise method + + + + + + + + +void initialise +() + + + + + + + + +## Implementation + +```dart +void initialise() { + _organizationService = locator(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md new file mode 100644 index 0000000000..fc9910f37b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel/orgMembersList.md @@ -0,0 +1,32 @@ + + + +# orgMembersList property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> orgMembersList + +_read / write_ + + + + + + +## Implementation + +```dart +late List orgMembersList = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/view_model_after_auth_view_models_chat_view_models_select_contact_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/view_model_after_auth_view_models_chat_view_models_select_contact_view_model-library.md new file mode 100644 index 0000000000..8d9207601d --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_chat_view_models_select_contact_view_model/view_model_after_auth_view_models_chat_view_models_select_contact_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# select_contact_view_model library + + + + + + + + + + + +## Classes + +##### [SelectContactViewModel](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md) + + + +SelectContactViewModel class have different functions to interact with model. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md new file mode 100644 index 0000000000..38267d729c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md @@ -0,0 +1,432 @@ + + + +# CreateEventViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- CreateEventViewModel + + + + + + + + +## Constructors + +[CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/CreateEventViewModel.md) () + + + + +## 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 FocusNode. +_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) + + + +Event Description Text Controller. +_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) + + + +Event End Date. +_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) + + + +Event End Time. +_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) + + + +Event Location Text Controller. +_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) + + + +Event Start Date. +_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) + + + +Event Start Time. +_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) + + + +Event Title Text Controller. +_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)> + + + +Global FormKey. +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [buildUserList](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md)() void + + + +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> + + + +This function is used to create the event for the organization. + + + + +##### [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_ + + + +##### [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. + + + + +##### [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> + + + +This function is used to get the image from gallery. + + + + +##### [initialize](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md)() void + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [removeImage](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md)() void + + + +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 + + + +Remove a previously registered closure from the list of closures that are +notified when the object changes. +_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 + + + +This function is used to remove a user from user's list. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/CreateEventViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/CreateEventViewModel.md new file mode 100644 index 0000000000..50eb1089f3 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/CreateEventViewModel.md @@ -0,0 +1,24 @@ + + + +# CreateEventViewModel constructor + + + + + + + +CreateEventViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md new file mode 100644 index 0000000000..49b43c3ff7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/buildUserList.md @@ -0,0 +1,50 @@ + + + +# buildUserList method + + + + + + + + +void buildUserList +() + + + + + +

This function build the user list.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void buildUserList() { + _selectedMembers.clear(); + + // loop through the organization member list + + orgMembersList.forEach((orgMember) { + if (_memberCheckedMap[orgMember.id] == true) { + _selectedMembers.add(orgMember); + } + }); + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md new file mode 100644 index 0000000000..e02be1250b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/createEvent.md @@ -0,0 +1,106 @@ + + + +# createEvent method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future createEvent() async { + titleFocus.unfocus(); + locationFocus.unfocus(); + descriptionFocus.unfocus(); + validate = AutovalidateMode.always; + if (formKey.currentState!.validate()) { + validate = AutovalidateMode.disabled; + + // variables initialisation + final DateTime startDate = eventStartDate; + final DateTime endDate = eventEndDate; + final DateTime startTime = DateTime( + startDate.year, + startDate.month, + startDate.day, + eventStartTime.hour, + eventStartTime.minute, + ); + final DateTime endTime = DateTime( + endDate.year, + endDate.month, + endDate.day, + eventEndTime.hour, + eventEndTime.minute, + ); + + // 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, + 'title': eventTitleTextController.text, + 'description': eventDescriptionTextController.text, + 'location': eventLocationTextController.text, + 'isPublic': isPublicSwitch, + 'isRegisterable': isRegisterableSwitch, + 'recurring': false, + 'allDay': false, + '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')), + ); + 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. + final result = await databaseFunctions.gqlAuthMutation( + EventQueries().addEvent(), + variables: variables, + ); + navigationService.pop(); + if (result != null) { + navigationService.pop(); + + await _eventService.getEvents(); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md new file mode 100644 index 0000000000..2d720cdd9e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/descriptionFocus.md @@ -0,0 +1,33 @@ + + + +# descriptionFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) descriptionFocus + +_read / write_ + + + +

DescriptionFocus FocusNode.

+ + + +## Implementation + +```dart +FocusNode descriptionFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md new file mode 100644 index 0000000000..abda49060e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventDescriptionTextController.md @@ -0,0 +1,34 @@ + + + +# eventDescriptionTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventDescriptionTextController + +_read / write_ + + + +

Event Description Text Controller.

+ + + +## Implementation + +```dart +TextEditingController eventDescriptionTextController = + TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md new file mode 100644 index 0000000000..2eae857b11 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndDate.md @@ -0,0 +1,33 @@ + + + +# eventEndDate property + + + + + + + +[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventEndDate + +_read / write_ + + + +

Event End Date.

+ + + +## Implementation + +```dart +DateTime eventEndDate = DateTime.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md new file mode 100644 index 0000000000..18d766fed0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventEndTime.md @@ -0,0 +1,33 @@ + + + +# eventEndTime property + + + + + + + +[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventEndTime + +_read / write_ + + + +

Event End Time.

+ + + +## Implementation + +```dart +TimeOfDay eventEndTime = TimeOfDay.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md new file mode 100644 index 0000000000..d371ed22b9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventLocationTextController.md @@ -0,0 +1,33 @@ + + + +# eventLocationTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventLocationTextController + +_read / write_ + + + +

Event Location Text Controller.

+ + + +## Implementation + +```dart +TextEditingController eventLocationTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md new file mode 100644 index 0000000000..d568203e39 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartDate.md @@ -0,0 +1,33 @@ + + + +# eventStartDate property + + + + + + + +[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventStartDate + +_read / write_ + + + +

Event Start Date.

+ + + +## Implementation + +```dart +DateTime eventStartDate = DateTime.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md new file mode 100644 index 0000000000..0ba2d449bb --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventStartTime.md @@ -0,0 +1,33 @@ + + + +# eventStartTime property + + + + + + + +[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventStartTime + +_read / write_ + + + +

Event Start Time.

+ + + +## Implementation + +```dart +TimeOfDay eventStartTime = TimeOfDay.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md new file mode 100644 index 0000000000..0ff98f1e47 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/eventTitleTextController.md @@ -0,0 +1,33 @@ + + + +# eventTitleTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventTitleTextController + +_read / write_ + + + +

Event Title Text Controller.

+ + + +## Implementation + +```dart +TextEditingController eventTitleTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md new file mode 100644 index 0000000000..8d24a83fcc --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/formKey.md @@ -0,0 +1,33 @@ + + + +# formKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey + +_final_ + + + +

Global FormKey.

+ + + +## Implementation + +```dart +final formKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md new file mode 100644 index 0000000000..dd2d7bc7f6 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getCurrentOrgUsersList.md @@ -0,0 +1,54 @@ + + + +# getCurrentOrgUsersList method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +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 + return orgMembersList; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md new file mode 100644 index 0000000000..8401473f63 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/getImageFromGallery.md @@ -0,0 +1,51 @@ + + + +# getImageFromGallery method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future getImageFromGallery({bool camera = false}) async { + final image = + await _multiMediaPickerService.getPhotoFromGallery(camera: camera); + if (image != null) { + _imageFile = image; + notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md new file mode 100644 index 0000000000..041c6defc8 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/imageFile.md @@ -0,0 +1,42 @@ + + + +# imageFile property + + + + + + + + + +[File](https://api.flutter.dev/flutter/dart-io/File-class.html)? imageFile + + + + + +

Getter to return imageFile.

+

params: +None

+

returns:

+
    +
  • File?: Returns imageFile.
  • +
+ + + +## Implementation + +```dart +File? get imageFile => _imageFile; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md new file mode 100644 index 0000000000..1f60b376dd --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/initialize.md @@ -0,0 +1,45 @@ + + + +# initialize method + + + + + + + + +void initialize +() + + + + + +

Function To Initialize.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void initialize() { + _currentOrg = _userConfig.currentOrg; + //_organizationService = locator(); + + _imageFile = null; + _multiMediaPickerService = locator(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md new file mode 100644 index 0000000000..8c49650a24 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isPublicSwitch.md @@ -0,0 +1,33 @@ + + + +# isPublicSwitch property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isPublicSwitch + +_read / write_ + + + +

Public Event or Not.

+ + + +## Implementation + +```dart +bool isPublicSwitch = true; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md new file mode 100644 index 0000000000..4c0808ed0b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/isRegisterableSwitch.md @@ -0,0 +1,33 @@ + + + +# isRegisterableSwitch property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isRegisterableSwitch + +_read / write_ + + + +

If event is registerable after creation.

+ + + +## Implementation + +```dart +bool isRegisterableSwitch = true; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md new file mode 100644 index 0000000000..da17e9b9c9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/latitude.md @@ -0,0 +1,33 @@ + + + +# latitude property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? latitude + +_read / write_ + + + +

Latitude store.

+ + + +## Implementation + +```dart +double? latitude; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md new file mode 100644 index 0000000000..df230e4933 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/locationFocus.md @@ -0,0 +1,33 @@ + + + +# locationFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) locationFocus + +_read / write_ + + + +

LocationFocus FocusNode.

+ + + +## Implementation + +```dart +FocusNode locationFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md new file mode 100644 index 0000000000..eba02e97c7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/longitude.md @@ -0,0 +1,33 @@ + + + +# longitude property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? longitude + +_read / write_ + + + +

Longitude store.

+ + + +## Implementation + +```dart +double? longitude; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md new file mode 100644 index 0000000000..81076cdb6f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/memberCheckedMap.md @@ -0,0 +1,43 @@ + + + +# memberCheckedMap property + + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Map get memberCheckedMap => _memberCheckedMap; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md new file mode 100644 index 0000000000..5e26fd9286 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/orgMembersList.md @@ -0,0 +1,33 @@ + + + +# orgMembersList property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> orgMembersList + +_read / write_ + + + +

Organisation Members List.

+ + + +## Implementation + +```dart +late List orgMembersList = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md new file mode 100644 index 0000000000..11b3c4f3e8 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeImage.md @@ -0,0 +1,42 @@ + + + +# removeImage method + + + + + + + + +void removeImage +() + + + + + +

This function remove the selected image.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void removeImage() { + _imageFile = null; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md new file mode 100644 index 0000000000..eafdab6ecd --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/removeUserFromList.md @@ -0,0 +1,46 @@ + + + +# removeUserFromList method + + + + + + + + +void removeUserFromList +({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

+ + + +## Implementation + +```dart +void removeUserFromList({required String userId}) { + _selectedMembers.removeWhere((user) => user.id == userId); + _memberCheckedMap[userId] = false; + + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md new file mode 100644 index 0000000000..cc72b1eb82 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/selectedMembers.md @@ -0,0 +1,42 @@ + + + +# selectedMembers property + + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +List get selectedMembers => _selectedMembers; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md new file mode 100644 index 0000000000..dafe064f75 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/titleFocus.md @@ -0,0 +1,33 @@ + + + +# titleFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) titleFocus + +_read / write_ + + + +

TitleFocus FocusNode.

+ + + +## Implementation + +```dart +FocusNode titleFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md new file mode 100644 index 0000000000..0c6ee84f70 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel/validate.md @@ -0,0 +1,33 @@ + + + +# validate property + + + + + + + +[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate + +_read / write_ + + + +

AutoValidateMode default to disabled.

+ + + +## Implementation + +```dart +AutovalidateMode validate = AutovalidateMode.disabled; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/view_model_after_auth_view_models_event_view_models_create_event_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/view_model_after_auth_view_models_event_view_models_create_event_view_model-library.md new file mode 100644 index 0000000000..71a0289785 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_create_event_view_model/view_model_after_auth_view_models_event_view_models_create_event_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# create_event_view_model library + + + + + + + + + + + +## Classes + +##### [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) + + + +CreateEventViewModel class have methods to interact with model in. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md new file mode 100644 index 0000000000..d2eed60cf2 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md @@ -0,0 +1,330 @@ + + + +# EditEventViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- EditEventViewModel + + + + + + + + +## Constructors + +[EditEventViewModel](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/EditEventViewModel.md) () + + + + +## 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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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)> + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [initialize](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md)([Event](../models_events_event_model/Event-class.md) event) void + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + +##### [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. + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/EditEventViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/EditEventViewModel.md new file mode 100644 index 0000000000..13fcad2a0f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/EditEventViewModel.md @@ -0,0 +1,24 @@ + + + +# EditEventViewModel constructor + + + + + + + +EditEventViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md new file mode 100644 index 0000000000..42e3cadfa1 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/descriptionFocus.md @@ -0,0 +1,32 @@ + + + +# descriptionFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) descriptionFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode descriptionFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md new file mode 100644 index 0000000000..6c46c7d62f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventDescriptionTextController.md @@ -0,0 +1,33 @@ + + + +# eventDescriptionTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventDescriptionTextController + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController eventDescriptionTextController = + TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md new file mode 100644 index 0000000000..9e06aaece5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndDate.md @@ -0,0 +1,32 @@ + + + +# eventEndDate property + + + + + + + +[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventEndDate + +_read / write_ + + + + + + +## Implementation + +```dart +DateTime eventEndDate = DateTime.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md new file mode 100644 index 0000000000..fbcf2e3a59 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventEndTime.md @@ -0,0 +1,32 @@ + + + +# eventEndTime property + + + + + + + +[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventEndTime + +_read / write_ + + + + + + +## Implementation + +```dart +TimeOfDay eventEndTime = TimeOfDay.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md new file mode 100644 index 0000000000..65a3646953 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventLocationTextController.md @@ -0,0 +1,32 @@ + + + +# eventLocationTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventLocationTextController + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController eventLocationTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md new file mode 100644 index 0000000000..0f6005ef74 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartDate.md @@ -0,0 +1,32 @@ + + + +# eventStartDate property + + + + + + + +[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) eventStartDate + +_read / write_ + + + + + + +## Implementation + +```dart +DateTime eventStartDate = DateTime.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md new file mode 100644 index 0000000000..4a0fbcbd6c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventStartTime.md @@ -0,0 +1,32 @@ + + + +# eventStartTime property + + + + + + + +[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) eventStartTime + +_read / write_ + + + + + + +## Implementation + +```dart +TimeOfDay eventStartTime = TimeOfDay.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md new file mode 100644 index 0000000000..a8880e96af --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/eventTitleTextController.md @@ -0,0 +1,32 @@ + + + +# eventTitleTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) eventTitleTextController + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController eventTitleTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md new file mode 100644 index 0000000000..d7de0e859a --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/formKey.md @@ -0,0 +1,32 @@ + + + +# formKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey + +_final_ + + + + + + +## Implementation + +```dart +final formKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md new file mode 100644 index 0000000000..1ecb6819cd --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/initialize.md @@ -0,0 +1,37 @@ + + + +# initialize method + + + + + + + + +void initialize +([Event](../../models_events_event_model/Event-class.md) event) + + + + + + + + +## Implementation + +```dart +void initialize(Event event) { + _event = event; + _fillEditForm(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md new file mode 100644 index 0000000000..3f1458f4be --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isPublicSwitch.md @@ -0,0 +1,32 @@ + + + +# isPublicSwitch property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isPublicSwitch + +_read / write_ + + + + + + +## Implementation + +```dart +bool isPublicSwitch = true; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md new file mode 100644 index 0000000000..02f53c66c7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/isRegisterableSwitch.md @@ -0,0 +1,32 @@ + + + +# isRegisterableSwitch property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isRegisterableSwitch + +_read / write_ + + + + + + +## Implementation + +```dart +bool isRegisterableSwitch = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md new file mode 100644 index 0000000000..bd199d216f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/locationFocus.md @@ -0,0 +1,32 @@ + + + +# locationFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) locationFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode locationFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md new file mode 100644 index 0000000000..43897adf9c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/titleFocus.md @@ -0,0 +1,32 @@ + + + +# titleFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) titleFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode titleFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md new file mode 100644 index 0000000000..5befd21fe1 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/updateEvent.md @@ -0,0 +1,73 @@ + + + +# updateEvent method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future updateEvent() async { + titleFocus.unfocus(); + locationFocus.unfocus(); + descriptionFocus.unfocus(); + validate = AutovalidateMode.always; + if (formKey.currentState!.validate()) { + validate = AutovalidateMode.disabled; + final DateTime startTime = DateTime( + eventStartDate.year, + eventStartDate.month, + eventStartDate.day, + eventStartTime.hour, + eventStartTime.minute, + ); + final DateTime endTime = DateTime( + eventEndDate.year, + eventEndDate.month, + eventEndDate.day, + eventEndTime.hour, + eventEndTime.minute, + ); + // map for the required data to update an event. + final Map variables = { + 'title': eventTitleTextController.text, + 'description': eventDescriptionTextController.text, + 'location': eventLocationTextController.text, + 'isPublic': isPublicSwitch, + 'isRegisterable': isRegisterableSwitch, + 'recurring': false, + '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', + }; + _eventService.editEvent(eventId: _event.id!, variables: variables); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md new file mode 100644 index 0000000000..7dd63a4d44 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel/validate.md @@ -0,0 +1,32 @@ + + + +# validate property + + + + + + + +[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate + +_read / write_ + + + + + + +## Implementation + +```dart +AutovalidateMode validate = AutovalidateMode.disabled; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/view_model_after_auth_view_models_event_view_models_edit_event_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/view_model_after_auth_view_models_event_view_models_edit_event_view_model-library.md new file mode 100644 index 0000000000..ea15b64719 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_edit_event_view_model/view_model_after_auth_view_models_event_view_models_edit_event_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# edit_event_view_model library + + + + + + + + + + + +## Classes + +##### [EditEventViewModel](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) + + + +EditEventViewModel class have methods to interact with model in +the context of editing the event in the organization. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md new file mode 100644 index 0000000000..ca90a6094d --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md @@ -0,0 +1,248 @@ + + + +# EventInfoViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- EventInfoViewModel + + + + + + + + +## Constructors + +[EventInfoViewModel](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/EventInfoViewModel.md) () + + + + +## Properties + +##### [event](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md) ↔ [Event](../models_events_event_model/Event-class.md) + + + + +_read / write_ + + + +##### [exploreEventsInstance](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md) ↔ [ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) + + + + +_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) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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. + + + + +##### [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> + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_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> + + + +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 + + + +Remove a previously registered closure from the list of closures that are +notified when the object changes. +_inherited_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/EventInfoViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/EventInfoViewModel.md new file mode 100644 index 0000000000..e97f407875 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/EventInfoViewModel.md @@ -0,0 +1,24 @@ + + + +# EventInfoViewModel constructor + + + + + + + +EventInfoViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md new file mode 100644 index 0000000000..c2c81ab4f0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/event.md @@ -0,0 +1,32 @@ + + + +# event property + + + + + + + +[Event](../../models_events_event_model/Event-class.md) event + +_read / write_ + + + + + + +## Implementation + +```dart +late Event event; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md new file mode 100644 index 0000000000..577772d851 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/exploreEventsInstance.md @@ -0,0 +1,32 @@ + + + +# exploreEventsInstance property + + + + + + + +[ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsInstance + +_read / write_ + + + + + + +## Implementation + +```dart +late ExploreEventsViewModel exploreEventsInstance; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md new file mode 100644 index 0000000000..ec2aa5e298 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/fabTitle.md @@ -0,0 +1,32 @@ + + + +# fabTitle property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) fabTitle + +_read / write_ + + + + + + +## Implementation + +```dart +late String fabTitle; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md new file mode 100644 index 0000000000..2c51f02c84 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/getFabTitle.md @@ -0,0 +1,43 @@ + + + +# getFabTitle method + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) getFabTitle +() + + + + + +

This function returns String type for the event registration status.

+ + + +## Implementation + +```dart +String getFabTitle() { + if (event.isRegisterable == false) { + return "Not Registrable"; + } else if (event.isRegistered == true) { + return "Registered"; + } else { + return "Register"; + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md new file mode 100644 index 0000000000..4c6cd87ca6 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/initialize.md @@ -0,0 +1,54 @@ + + + +# initialize method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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() + .fetchRegistrantsByEvent(event.id!) as QueryResult; + final registrantsJsonList = fetchRegistrantsByEventQueryResult + .data!['registrantsByEvent'] as List; + registrants = registrantsJsonList + .map( + (registrantJson) => User.fromJson( + registrantJson! as Map, + fromOrg: true, + ), + ) + .toList(); + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md new file mode 100644 index 0000000000..453b650751 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registerForEvent.md @@ -0,0 +1,58 @@ + + + +# registerForEvent method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> registerForEvent +() + + + + + +

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) { + navigationService.pushDialog( + const CustomProgressDialog( + key: Key('RegisterEvent'), + ), + ); + + // 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) { + event.isRegistered = true; + registrants.add(locator().currentUser); + } + print(registerResult); + fabTitle = getFabTitle(); + navigationService.pop(); + notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md new file mode 100644 index 0000000000..3074b46da9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel/registrants.md @@ -0,0 +1,32 @@ + + + +# registrants property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[User](../../models_user_user_info/User-class.md)> registrants + +_read / write_ + + + + + + +## Implementation + +```dart +late List registrants; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/view_model_after_auth_view_models_event_view_models_event_info_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/view_model_after_auth_view_models_event_view_models_event_info_view_model-library.md new file mode 100644 index 0000000000..d652071d56 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_event_info_view_model/view_model_after_auth_view_models_event_view_models_event_info_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# event_info_view_model library + + + + + + + + + + + +## Classes + +##### [EventInfoViewModel](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md) + + + +EventInfoViewModel class helps interacting with model to serve view with the event information data.' + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md new file mode 100644 index 0000000000..0db9f1f4b0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md @@ -0,0 +1,281 @@ + + + +# ExploreEventsViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- ExploreEventsViewModel + + + + + + + + +## Constructors + +[ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/ExploreEventsViewModel.md) () + + + + +## 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) + + + + +_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) + + + + +_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)> + + + + +_read-only_ + + + +##### [eventService](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md) → [EventService](../services_event_service/EventService-class.md) + + + + +_read-only_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_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> + + + +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> + + + +This function takes the choosen value from dropdown and +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> + + + +This function deletes the event. + + + + +##### [dispose](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md)() 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). +_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> + + + +This function is used to fetch new events in the organization. +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> + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_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> + + + +This function is used to refresh the events in the organization. +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 + + + +Remove a previously registered closure from the list of closures that are +notified when the object changes. +_inherited_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/ExploreEventsViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/ExploreEventsViewModel.md new file mode 100644 index 0000000000..ee83f259c7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/ExploreEventsViewModel.md @@ -0,0 +1,24 @@ + + + +# ExploreEventsViewModel constructor + + + + + + + +ExploreEventsViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md new file mode 100644 index 0000000000..e16d37fb29 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/checkIfExistsAndAddNewEvent.md @@ -0,0 +1,47 @@ + + + +# checkIfExistsAndAddNewEvent method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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)) { + _uniqueEventIds.add(newEvent.id!); + _parseEventDateTime(newEvent); + notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md new file mode 100644 index 0000000000..a875ad66ac --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/choseValueFromDropdown.md @@ -0,0 +1,117 @@ + + + +# choseValueFromDropdown method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future choseValueFromDropdown(String value) async { + _chosenValue = value; + notifyListeners(); + setState(ViewState.busy); + + switch (_chosenValue) { + // if `_chosenValue` is "All events". + case 'All Events': + { + // all events + _events = _bufferEvents; + // if list is empty + _emptyListMessage = "Looks like there aren't any events."; + } + break; + // if `_chosenValue` is "created event". + case 'Created Events': + { + // 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, + ), + ); + // if list is empty + _emptyListMessage = "You have not created any event."; + } + break; + // 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. + _events = List.from( + _bufferEvents.where( + (element) => + element.isRegistered == true && + element.creator!.id != userConfig.currentUser.id, + ), + ); + // if list is empty + _emptyListMessage = "No registered events are present"; + } + break; + // if `_chosenValue` is "Registered Events". + case 'Public Events': + { + // loop through the `_events` list and filter elements + // with the `isPublic` as true. + _events = _bufferEvents + .where((element) => element.isPublic == true) + .toList(); + + // 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. + _events = _bufferEvents + .where((element) => element.isPublic == false) + .toList(); + // 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/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md new file mode 100644 index 0000000000..d75248d697 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/chosenValue.md @@ -0,0 +1,35 @@ + + + +# chosenValue property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) chosenValue + + + + + + + + +## Implementation + +```dart +String get chosenValue => _chosenValue; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md new file mode 100644 index 0000000000..62435c10d0 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/deleteEvent.md @@ -0,0 +1,64 @@ + + + +# deleteEvent method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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: () { + navigationService.pop(); + _eventService.deleteEvent(eventId).then( + (result) async { + if (result != null) { + navigationService.pop(); + setState(ViewState.busy); + print(result); + _uniqueEventIds.remove(eventId); + _events.removeWhere((element) => element.id == eventId); + await Future.delayed(const Duration(milliseconds: 500)); + setState(ViewState.idle); + } + }, + ); + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md new file mode 100644 index 0000000000..6c23fac6a5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/dispose.md @@ -0,0 +1,47 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_override_ + + + +

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 +it is called. Consumers of this class must decide on whether to notify +listeners or not immediately before disposal.

+ + + +## Implementation + +```dart +@override +void dispose() { + _eventStreamSubscription.cancel(); + _currentOrganizationStreamSubscription.cancel(); + super.dispose(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md new file mode 100644 index 0000000000..9f89f47baf --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/emptyListMessage.md @@ -0,0 +1,35 @@ + + + +# emptyListMessage property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) emptyListMessage + + + + + + + + +## Implementation + +```dart +String get emptyListMessage => _emptyListMessage; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md new file mode 100644 index 0000000000..face3b442d --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/eventService.md @@ -0,0 +1,35 @@ + + + +# eventService property + + + + + + + + + +[EventService](../../services_event_service/EventService-class.md) eventService + + + + + + + + +## Implementation + +```dart +EventService get eventService => _eventService; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md new file mode 100644 index 0000000000..c267070c56 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/events.md @@ -0,0 +1,35 @@ + + + +# events property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> events + + + + + + + + +## Implementation + +```dart +List get events => _events; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md new file mode 100644 index 0000000000..9722f847c5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/fetchNewEvents.md @@ -0,0 +1,41 @@ + + + +# fetchNewEvents method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future fetchNewEvents() async { + setState(ViewState.busy); + notifyListeners(); + await _eventService.getEvents(); + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md new file mode 100644 index 0000000000..cb43c5c962 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/initialise.md @@ -0,0 +1,45 @@ + + + +# initialise method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +() + + + + + + + + +## Implementation + +```dart +Future initialise() async { + setState(ViewState.busy); + _currentOrganizationStreamSubscription = userConfig.currentOrgInfoStream + .listen((updatedOrganization) => refreshEvents()); + await _eventService.getEvents(); + + _eventStreamSubscription = _eventService.eventStream.listen( + (newEvent) => checkIfExistsAndAddNewEvent(newEvent), + ); + _bufferEvents = _events; + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md new file mode 100644 index 0000000000..ed1c495c5c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel/refreshEvents.md @@ -0,0 +1,42 @@ + + + +# refreshEvents method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future refreshEvents() async { + setState(ViewState.busy); + _events.clear(); + _uniqueEventIds.clear(); + await _eventService.getEvents(); + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/view_model_after_auth_view_models_event_view_models_explore_events_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/view_model_after_auth_view_models_event_view_models_explore_events_view_model-library.md new file mode 100644 index 0000000000..c28d0174cc --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_event_view_models_explore_events_view_model/view_model_after_auth_view_models_event_view_models_explore_events_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# explore_events_view_model library + + + + + + + + + + + +## Classes + +##### [ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) + + + +ExploreEventsViewModel class helps to interact with model to serve data to view for event explore section. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md new file mode 100644 index 0000000000..3241daad6d --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md @@ -0,0 +1,306 @@ + + + +# OrganizationFeedViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- OrganizationFeedViewModel + + + + + + + + +## Constructors + +[OrganizationFeedViewModel](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/OrganizationFeedViewModel.md) () + + + + +## 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) + + + + +_read-only_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [addNewPost](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md)([Post](../models_post_post_model/Post-class.md) newPost) void + + + +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 + + + +This function initialise _posts with newPosts. + + + + +##### [dispose](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md)() 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). +_override_ + + + +##### [fetchNewPosts](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md)() void + + + +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 + + + + + + + + +##### [initializeWithDemoData](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md)() void + + + + + + + + +##### [navigateToIndividualPage](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md)([Post](../models_post_post_model/Post-class.md) post) void + + + +This function navigate to individual post page. + + + + +##### [navigateToPinnedPostPage](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md)() void + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [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 + + + +This function sets the organization name after update. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + +##### [updatedPost](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md)([Post](../models_post_post_model/Post-class.md) post) void + + + +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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/OrganizationFeedViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/OrganizationFeedViewModel.md new file mode 100644 index 0000000000..67813533b7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/OrganizationFeedViewModel.md @@ -0,0 +1,24 @@ + + + +# OrganizationFeedViewModel constructor + + + + + + + +OrganizationFeedViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md new file mode 100644 index 0000000000..8c2c03afe3 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/addNewPost.md @@ -0,0 +1,42 @@ + + + +# addNewPost method + + + + + + + + +void addNewPost +([Post](../../models_post_post_model/Post-class.md) newPost) + + + + + +

This function adds new Post.

+

params:

+
    +
  • newPost
  • +
+ + + +## Implementation + +```dart +void addNewPost(Post newPost) { + _posts.insert(0, newPost); + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md new file mode 100644 index 0000000000..55261441cd --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/buildNewPosts.md @@ -0,0 +1,42 @@ + + + +# buildNewPosts method + + + + + + + + +void buildNewPosts +([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
  • +
+ + + +## Implementation + +```dart +void buildNewPosts(List newPosts) { + _posts = newPosts; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md new file mode 100644 index 0000000000..9688a5a1b9 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/currentOrgName.md @@ -0,0 +1,35 @@ + + + +# currentOrgName property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) currentOrgName + + + + + + + + +## Implementation + +```dart +String get currentOrgName => _currentOrgName; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md new file mode 100644 index 0000000000..b9bddb208f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/dispose.md @@ -0,0 +1,49 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_override_ + + + +

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 +it is called. Consumers of this class must decide on whether to notify +listeners or not immediately before disposal.

+ + + +## Implementation + +```dart +@override +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/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md new file mode 100644 index 0000000000..a01c185d7c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/fetchNewPosts.md @@ -0,0 +1,37 @@ + + + +# fetchNewPosts method + + + + + + + + +void fetchNewPosts +() + + + + + +

This function fetches new posts in the organization.

+ + + +## Implementation + +```dart +void fetchNewPosts() { + _postService.getPosts(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md new file mode 100644 index 0000000000..cea956cdba --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initialise.md @@ -0,0 +1,58 @@ + + + +# initialise method + + + + + + + + +void initialise +({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) + + + + + + + + +## Implementation + +```dart +void initialise( + // bool forTest, + { + bool isTest = false, +}) { + // 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 + _currentOrganizationStreamSubscription = + _userConfig.currentOrgInfoStream.listen( + (updatedOrganization) => + setCurrentOrganizationName(updatedOrganization.name!), + ); + _postsSubscription = _postService.postStream.listen((newPosts) { + return buildNewPosts(newPosts); + }); + + _updatePostSubscription = + _postService.updatedPostStream.listen((post) => updatedPost(post)); + if (isTest) { + istest = true; + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md new file mode 100644 index 0000000000..a6589facc8 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/initializeWithDemoData.md @@ -0,0 +1,46 @@ + + + +# initializeWithDemoData method + + + + + + + + +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)); + // }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md new file mode 100644 index 0000000000..7b27c4dd8a --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/istest.md @@ -0,0 +1,32 @@ + + + +# istest property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) istest + +_read / write_ + + + + + + +## Implementation + +```dart +bool istest = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md new file mode 100644 index 0000000000..82d923bcdf --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToIndividualPage.md @@ -0,0 +1,38 @@ + + + +# navigateToIndividualPage method + + + + + + + + +void navigateToIndividualPage +([Post](../../models_post_post_model/Post-class.md) post) + + + + + +

This function navigate to individual post page.

+ + + +## Implementation + +```dart +void navigateToIndividualPage(Post post) { + // uses `pushScreen` method by `navigationService` service. + _navigationService.pushScreen(Routes.individualPost, arguments: post); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md new file mode 100644 index 0000000000..75f8159c1f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/navigateToPinnedPostPage.md @@ -0,0 +1,41 @@ + + + +# navigateToPinnedPostPage method + + + + + + + + +void navigateToPinnedPostPage +() + + + + + +

This function navigate to pinned post page.

+ + + +## Implementation + +```dart +void navigateToPinnedPostPage() { + // uses `pushScreen` method by `navigationService` service. + _navigationService.pushScreen( + Routes.pinnedPostPage, + arguments: _pinnedPosts, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md new file mode 100644 index 0000000000..88ef2709ee --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/pinnedPosts.md @@ -0,0 +1,41 @@ + + + +# pinnedPosts property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts + + + + + + + + +## Implementation + +```dart +List get pinnedPosts { + if (istest) { + _pinnedPosts = []; + return _pinnedPosts; + } + return _pinnedPosts; +} +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md new file mode 100644 index 0000000000..be2240d6a6 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/posts.md @@ -0,0 +1,41 @@ + + + +# posts property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> posts + + + + + + + + +## Implementation + +```dart +List get posts { + // if (istest) { + // _posts = pinnedPostsDemoData.map((e) => Post.fromJson(e)).toList(); + // return _posts; + // } + return _posts; +} +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md new file mode 100644 index 0000000000..df80565db6 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/setCurrentOrganizationName.md @@ -0,0 +1,48 @@ + + + +# setCurrentOrganizationName method + + + + + + + + +void setCurrentOrganizationName +([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.
  • +
+ + + +## Implementation + +```dart +void setCurrentOrganizationName(String updatedOrganization) { + // if `updatedOrganization` is not same to `_currentOrgName`. + if (updatedOrganization != _currentOrgName) { + _posts.clear(); + _renderedPostID.clear(); + _currentOrgName = updatedOrganization; + notifyListeners(); + } + // _postService.getPosts(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md new file mode 100644 index 0000000000..ad276dec3f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel/updatedPost.md @@ -0,0 +1,47 @@ + + + +# updatedPost method + + + + + + + + +void updatedPost +([Post](../../models_post_post_model/Post-class.md) 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) { + _posts[i] = post; + notifyListeners(); + break; + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model-library.md new file mode 100644 index 0000000000..4f9361201b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/view_model_after_auth_view_models_feed_view_models_organization_feed_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# organization_feed_view_model library + + + + + + + + + + + +## Classes + +##### [OrganizationFeedViewModel](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md) + + + +OrganizationFeedViewModel class helps to interact with model to serve data to view for organization feed section. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md new file mode 100644 index 0000000000..f83ea766cf --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md @@ -0,0 +1,275 @@ + + + +# EditProfilePageViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- EditProfilePageViewModel + + + + + + + + +## Constructors + +[EditProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/EditProfilePageViewModel.md) () + + + + +## Properties + +##### [databaseService](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md) → [DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions-class.md) + + + + +_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) + + + + +_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) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [user](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md) → [User](../models_user_user_info/User-class.md) + + + + +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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. + + + + +##### [initialize](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md)() void + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [removeImage](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md)() void + + + +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 + + + +Remove a previously registered closure from the list of closures that are +notified when the object changes. +_inherited_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/EditProfilePageViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/EditProfilePageViewModel.md new file mode 100644 index 0000000000..0bac4a494a --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/EditProfilePageViewModel.md @@ -0,0 +1,24 @@ + + + +# EditProfilePageViewModel constructor + + + + + + + +EditProfilePageViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md new file mode 100644 index 0000000000..611b939855 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/databaseService.md @@ -0,0 +1,32 @@ + + + +# databaseService property + + + + + + + +[DataBaseMutationFunctions](../../services_database_mutation_functions/DataBaseMutationFunctions-class.md) databaseService + +_final_ + + + + + + +## Implementation + +```dart +final databaseService = databaseFunctions; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md new file mode 100644 index 0000000000..48ab5e6a56 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameFocus.md @@ -0,0 +1,32 @@ + + + +# firstNameFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) firstNameFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode firstNameFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md new file mode 100644 index 0000000000..ad9f13aa61 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/firstNameTextController.md @@ -0,0 +1,32 @@ + + + +# firstNameTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) firstNameTextController + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController firstNameTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md new file mode 100644 index 0000000000..b1f5eda7ce --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/getImageFromGallery.md @@ -0,0 +1,47 @@ + + + +# getImageFromGallery method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future getImageFromGallery({bool camera = false}) async { + final image = + await _multiMediaPickerService.getPhotoFromGallery(camera: camera); + if (image != null) { + imageFile = image; + notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md new file mode 100644 index 0000000000..57c47fbe12 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/imageFile.md @@ -0,0 +1,32 @@ + + + +# imageFile property + + + + + + + +[File](https://api.flutter.dev/flutter/dart-io/File-class.html)? imageFile + +_read / write_ + + + + + + +## Implementation + +```dart +late File? imageFile; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md new file mode 100644 index 0000000000..0c1fdae5c7 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/initialize.md @@ -0,0 +1,37 @@ + + + +# initialize method + + + + + + + + +void initialize +() + + + + + + + + +## Implementation + +```dart +void initialize() { + imageFile = null; + _multiMediaPickerService = locator(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md new file mode 100644 index 0000000000..e304beed05 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameFocus.md @@ -0,0 +1,32 @@ + + + +# lastNameFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) lastNameFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode lastNameFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md new file mode 100644 index 0000000000..e7cd6c0a28 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/lastNameTextController.md @@ -0,0 +1,32 @@ + + + +# lastNameTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) lastNameTextController + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController lastNameTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md new file mode 100644 index 0000000000..2f0f573c0b --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/removeImage.md @@ -0,0 +1,38 @@ + + + +# removeImage method + + + + + + + + +void removeImage +() + + + + + +

This function remove the selected image.

+ + + +## Implementation + +```dart +void removeImage() { + imageFile = null; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md new file mode 100644 index 0000000000..d20415aecd --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel/user.md @@ -0,0 +1,32 @@ + + + +# user property + + + + + + + +[User](../../models_user_user_info/User-class.md) user + +_final_ + + + + + + +## Implementation + +```dart +final user = userConfig.currentUser; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model-library.md new file mode 100644 index 0000000000..6d453459bc --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/view_model_after_auth_view_models_profile_view_models_edit_profile_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# edit_profile_view_model library + + + + + + + + + + + +## Classes + +##### [EditProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md) + + + +EditProfilePageViewModel class helps to interact with model to serve data to edit profile views. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md new file mode 100644 index 0000000000..399f3e7893 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md @@ -0,0 +1,385 @@ + + + +# ProfilePageViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- ProfilePageViewModel + + + + + + + + +## Constructors + +[ProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/ProfilePageViewModel.md) () + + + + +## 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) + + + + +_read / write_ + + + +##### [currentOrg](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_read / write_ + + + +##### [currentUser](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md) ↔ [User](../models_user_user_info/User-class.md) + + + + +_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)> + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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 + + + + + + + + +##### [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 + + + +This method changes the currency of the user for donation purpose. + + + + +##### [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_ + + + +##### [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) + + + +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) + + + +This widget returns the button for social media sharing option. + + + + +##### [initialize](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md)() 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 + + + +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. + + + + +##### [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> + + + +This method destroys the user's session or sign out the user from app. +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [popBottomSheet](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md)() 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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_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 + + + + + + + + +##### [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_ + + + +##### [updateSheetHeight](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md)() void + + + + + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/ProfilePageViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/ProfilePageViewModel.md new file mode 100644 index 0000000000..d85feb2839 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/ProfilePageViewModel.md @@ -0,0 +1,24 @@ + + + +# ProfilePageViewModel constructor + + + + + + + +ProfilePageViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md new file mode 100644 index 0000000000..edcf927825 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/attachListener.md @@ -0,0 +1,50 @@ + + + +# attachListener method + + + + + + + + +void attachListener +([Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setter) + + + + + + + + +## Implementation + +```dart +void attachListener(Function setter) { + donationField.addListener(() { + if (donationField.hasFocus) { + setter(() { + bottomSheetHeight = SizeConfig.screenHeight! * 0.8725; + }); + } else { + Future.delayed(const Duration(milliseconds: 300), () { + { + setter(() { + bottomSheetHeight = SizeConfig.screenHeight! * 0.68; + }); + } + }); + } + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md new file mode 100644 index 0000000000..6b02dd5428 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/bottomSheetHeight.md @@ -0,0 +1,32 @@ + + + +# bottomSheetHeight property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html) bottomSheetHeight + +_read / write_ + + + + + + +## Implementation + +```dart +double bottomSheetHeight = SizeConfig.screenHeight! * 0.68; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md new file mode 100644 index 0000000000..123044aa49 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/changeCurrency.md @@ -0,0 +1,46 @@ + + + +# changeCurrency method + + + + + + + + +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) + + + + + +

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

+ + + +## Implementation + +```dart +void changeCurrency(BuildContext context, Function setter) { + showCurrencyPicker( + context: context, + currencyFilter: supportedCurrencies, + onSelect: (Currency currency) { + setter(() { + donationCurrency = currency.code; + donationCurrencySymbol = currency.symbol; + }); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md new file mode 100644 index 0000000000..6455d508dd --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentOrg.md @@ -0,0 +1,32 @@ + + + +# currentOrg property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) currentOrg + +_read / write_ + + + + + + +## Implementation + +```dart +late OrgInfo currentOrg; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md new file mode 100644 index 0000000000..e955d40624 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/currentUser.md @@ -0,0 +1,32 @@ + + + +# currentUser property + + + + + + + +[User](../../models_user_user_info/User-class.md) currentUser + +_read / write_ + + + + + + +## Implementation + +```dart +late User currentUser; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md new file mode 100644 index 0000000000..d75e715f01 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/denomination.md @@ -0,0 +1,32 @@ + + + +# denomination property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> denomination + +_final_ + + + + + + +## Implementation + +```dart +final List denomination = ['1', '5', '10']; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md new file mode 100644 index 0000000000..b69ecf7161 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/dominationButton.md @@ -0,0 +1,68 @@ + + + +# dominationButton method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Widget dominationButton( + String amount, + BuildContext context, + Function setter, +) { + return InkWell( + onTap: () { + setter(() { + donationAmount.text = amount; + }); + }, + child: Container( + padding: EdgeInsets.symmetric( + vertical: SizeConfig.screenHeight! * 0.02, + horizontal: SizeConfig.screenWidth! * 0.075, + ), + decoration: BoxDecoration( + borderRadius: BorderRadius.circular(10), + color: donationAmount.text == amount + ? Theme.of(context).colorScheme.secondary + : Theme.of(context).colorScheme.primary, + ), + child: Text( + '$donationCurrencySymbol $amount', + style: Theme.of(context).textTheme.titleMedium, + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md new file mode 100644 index 0000000000..9ce57b2586 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationAmount.md @@ -0,0 +1,32 @@ + + + +# donationAmount property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) donationAmount + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController donationAmount = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md new file mode 100644 index 0000000000..aacae7fd41 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrency.md @@ -0,0 +1,32 @@ + + + +# donationCurrency property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) donationCurrency + +_read / write_ + + + + + + +## Implementation + +```dart +String donationCurrency = "USD"; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md new file mode 100644 index 0000000000..bd1213350e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationCurrencySymbol.md @@ -0,0 +1,32 @@ + + + +# donationCurrencySymbol property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) donationCurrencySymbol + +_read / write_ + + + + + + +## Implementation + +```dart +String donationCurrencySymbol = "\$"; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md new file mode 100644 index 0000000000..a8002fbd95 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/donationField.md @@ -0,0 +1,32 @@ + + + +# donationField property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) donationField + +_final_ + + + + + + +## Implementation + +```dart +final FocusNode donationField = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md new file mode 100644 index 0000000000..3c4daade75 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/iconButton.md @@ -0,0 +1,52 @@ + + + +# iconButton method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Widget iconButton(Widget icon, Function onTap) { + return Stack( + children: [ + IconButton( + onPressed: () { + print('tapped'); + onTap(); + }, + icon: icon, + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md new file mode 100644 index 0000000000..831375087c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/initialize.md @@ -0,0 +1,39 @@ + + + +# initialize method + + + + + + + + +void initialize +() + + + + + + + + +## Implementation + +```dart +void initialize() { + setState(ViewState.busy); + currentOrg = _userConfig.currentOrg; + currentUser = _userConfig.currentUser; + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md new file mode 100644 index 0000000000..3126aa8f9c --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/invite.md @@ -0,0 +1,134 @@ + + + +# invite method + + + + + + + + +void invite +([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.

+ + + +## Implementation + +```dart +void invite(BuildContext context) { + _appLanguageService.initialize(); + // organization url + final String url = + '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!}'; + print(url); + print(qrData); + showModalBottomSheet( + context: context, + shape: const RoundedRectangleBorder( + borderRadius: BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + ), + builder: (BuildContext context) { + return ClipRRect( + borderRadius: const BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + child: Container( + height: MediaQuery.of(context).size.height * 0.75, + decoration: const BoxDecoration( + color: Colors.white, + ), + child: Column( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.center, + crossAxisAlignment: CrossAxisAlignment.center, + children: [ + QrImage( + data: qrData, + version: QrVersions.auto, + size: 200.0, + foregroundColor: Colors.black, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.08, + ), + Text( + 'Scan the QR to join ${userConfig.currentOrg.name}', + style: const TextStyle(color: Colors.black), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.02, + ), + Row( + mainAxisAlignment: MainAxisAlignment.spaceEvenly, + mainAxisSize: MainAxisSize.min, + children: [ + iconButton( + const FaIcon( + FontAwesomeIcons.twitter, + size: 35, + color: Color(0xFF1DA1F2), + ), + () 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 + painter: WhatsappLogo(), + ), + () 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 + painter: TelegramLogo(), + ), + () async => SocialShare.shareTelegram(url), + ), + iconButton( + const FaIcon( + FontAwesomeIcons.shareNodes, + size: 30, + color: Color(0xff40c351), + ), + () async => SocialShare.shareOptions(url), + ), + ], + ) + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md new file mode 100644 index 0000000000..32f820dbc2 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/logout.md @@ -0,0 +1,86 @@ + + + +# logout method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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 { + final result = await databaseFunctions + .gqlAuthMutation(queries.logout()) as QueryResult?; + 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'); + url = Hive.box('url'); + final androidFirebaseOptionsBox = + Hive.box('androidFirebaseOptions'); + final iosFirebaseOptionsBox = Hive.box('iosFirebaseOptions'); + organisation = Hive.box('currentOrg'); + user.clear(); + url.clear(); + androidFirebaseOptionsBox.clear(); + iosFirebaseOptionsBox.clear(); + try { + Firebase.app() + .delete(); // Deleting app will stop all Firebase plugins + } catch (e) { + debugPrint("ERROR: Unable to delete firebase app $e"); + } + organisation.clear(); + navigationService.pop(); + navigationService.removeAllAndPush( + '/selectLang', + '/', + arguments: '0', + ); + }); + } + } catch (e) { + print(e); + } + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md new file mode 100644 index 0000000000..3d34e04e3e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/organisation.md @@ -0,0 +1,32 @@ + + + +# organisation property + + + + + + + +[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> organisation + +_latefinal_ + + + + + + +## Implementation + +```dart +late final Box organisation; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md new file mode 100644 index 0000000000..13718f6ff4 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/popBottomSheet.md @@ -0,0 +1,36 @@ + + + +# popBottomSheet method + + + + + + + + +void popBottomSheet +() + + + + + + + + +## Implementation + +```dart +void popBottomSheet() { + _navigationService.pop(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md new file mode 100644 index 0000000000..2ecabe5005 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/scaffoldKey.md @@ -0,0 +1,32 @@ + + + +# scaffoldKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)> scaffoldKey + +_final_ + + + + + + +## Implementation + +```dart +final GlobalKey scaffoldKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md new file mode 100644 index 0000000000..aabf7b6b9d --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/showSnackBar.md @@ -0,0 +1,36 @@ + + + +# showSnackBar method + + + + + + + + +void showSnackBar +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) message) + + + + + + + + +## Implementation + +```dart +void showSnackBar(String message) { + _navigationService.showTalawaErrorDialog(message, MessageType.error); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md new file mode 100644 index 0000000000..e79f361a21 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/updateSheetHeight.md @@ -0,0 +1,37 @@ + + + +# updateSheetHeight method + + + + + + + + +void updateSheetHeight +() + + + + + + + + +## Implementation + +```dart +void updateSheetHeight() { + bottomSheetHeight = SizeConfig.screenHeight! * 0.65; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md new file mode 100644 index 0000000000..0c2f3bed73 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/url.md @@ -0,0 +1,32 @@ + + + +# url property + + + + + + + +[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html) url + +_latefinal_ + + + + + + +## Implementation + +```dart +late final Box url; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md new file mode 100644 index 0000000000..441993dc65 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel/user.md @@ -0,0 +1,32 @@ + + + +# user property + + + + + + + +[Box](https://pub.dev/documentation/hive/2.2.3/hive/Box-class.html)<[User](../../models_user_user_info/User-class.md)> user + +_latefinal_ + + + + + + +## Implementation + +```dart +late final Box user; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/view_model_after_auth_view_models_profile_view_models_profile_page_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/view_model_after_auth_view_models_profile_view_models_profile_page_view_model-library.md new file mode 100644 index 0000000000..02602c2f76 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_profile_view_models_profile_page_view_model/view_model_after_auth_view_models_profile_view_models_profile_page_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# profile_page_view_model library + + + + + + + + + + + +## Classes + +##### [ProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md) + + + +ProfilePageViewModel class helps to interact with model to serve data +and react to user's input in Profile Page view. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md new file mode 100644 index 0000000000..4050b66dff --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md @@ -0,0 +1,252 @@ + + + +# CreateTaskViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- CreateTaskViewModel + + + + + + + + +## Constructors + +[CreateTaskViewModel](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/CreateTaskViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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. + + + + +##### [dispose](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md)() 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). +_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)> + + + +This function updates the task. +The function uses editTask method provided by Task Services. + + + + +##### [fillTask](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md)([Task](../models_task_task_model/Task-class.md) task) void + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/CreateTaskViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/CreateTaskViewModel.md new file mode 100644 index 0000000000..ddf3030888 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/CreateTaskViewModel.md @@ -0,0 +1,24 @@ + + + +# CreateTaskViewModel constructor + + + + + + + +CreateTaskViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md new file mode 100644 index 0000000000..5bcc17868a --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/createTask.md @@ -0,0 +1,54 @@ + + + +# createTask method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future createTask(String eventId) async { + final deadline = DateTime( + taskEndDate.year, + taskEndDate.month, + taskEndDate.day, + taskEndTime.hour, + taskEndTime.minute, + ); + return _taskService.createTask( + title: taskTitleTextController.text, + description: taskDescriptionTextController.text, + deadline: deadline.microsecondsSinceEpoch.toString(), + eventId: eventId, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md new file mode 100644 index 0000000000..2204180337 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/dispose.md @@ -0,0 +1,47 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_override_ + + + +

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 +it is called. Consumers of this class must decide on whether to notify +listeners or not immediately before disposal.

+ + + +## Implementation + +```dart +@override +void dispose() { + taskTitleTextController.dispose(); + taskDescriptionTextController.dispose(); + super.dispose(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md new file mode 100644 index 0000000000..bb4079d46d --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/editTask.md @@ -0,0 +1,54 @@ + + + +# editTask method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future editTask(String taskId) async { + final deadline = DateTime( + taskEndDate.year, + taskEndDate.month, + taskEndDate.day, + taskEndTime.hour, + taskEndTime.minute, + ); + return _taskService.editTask( + title: taskTitleTextController.text, + description: taskDescriptionTextController.text, + deadline: deadline.microsecondsSinceEpoch.toString(), + taskId: taskId, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md new file mode 100644 index 0000000000..5bea4157aa --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/fillTask.md @@ -0,0 +1,47 @@ + + + +# fillTask method + + + + + + + + +void fillTask +([Task](../../models_task_task_model/Task-class.md) task) + + + + + +

This functions fills the task controller data.

+

params:

+
    +
  • task : Task type contain task data.
  • +
+ + + +## Implementation + +```dart +void fillTask(Task task) { + taskTitleTextController.text = task.title; + taskDescriptionTextController.text = task.description ?? ''; + if (task.deadline != null) { + taskEndDate = + DateTime.fromMicrosecondsSinceEpoch(int.parse(task.deadline!)); + taskEndTime = TimeOfDay.fromDateTime(taskEndDate); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md new file mode 100644 index 0000000000..7f032da666 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskDescriptionTextController.md @@ -0,0 +1,32 @@ + + + +# taskDescriptionTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) taskDescriptionTextController + +_final_ + + + + + + +## Implementation + +```dart +final taskDescriptionTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md new file mode 100644 index 0000000000..696d43408e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndDate.md @@ -0,0 +1,32 @@ + + + +# taskEndDate property + + + + + + + +[DateTime](https://api.flutter.dev/flutter/dart-core/DateTime-class.html) taskEndDate + +_read / write_ + + + + + + +## Implementation + +```dart +DateTime taskEndDate = DateTime.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md new file mode 100644 index 0000000000..3e1250440e --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskEndTime.md @@ -0,0 +1,32 @@ + + + +# taskEndTime property + + + + + + + +[TimeOfDay](https://api.flutter.dev/flutter/material/TimeOfDay-class.html) taskEndTime + +_read / write_ + + + + + + +## Implementation + +```dart +TimeOfDay taskEndTime = TimeOfDay.now(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md new file mode 100644 index 0000000000..9936df3991 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel/taskTitleTextController.md @@ -0,0 +1,32 @@ + + + +# taskTitleTextController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) taskTitleTextController + +_final_ + + + + + + +## Implementation + +```dart +final taskTitleTextController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/view_model_after_auth_view_models_task_view_models_create_task_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/view_model_after_auth_view_models_task_view_models_create_task_view_model-library.md new file mode 100644 index 0000000000..cfbe42c2b1 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_create_task_view_model/view_model_after_auth_view_models_task_view_models_create_task_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# create_task_view_model library + + + + + + + + + + + +## Classes + +##### [CreateTaskViewModel](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md) + + + +CreateTaskViewModel class helps to interact with model to serve data +and react to user's input in Create Task view. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md new file mode 100644 index 0000000000..688e124ea5 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md @@ -0,0 +1,226 @@ + + + +# ExploreTasksViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- ExploreTasksViewModel + + + + + + + + +## Constructors + +[ExploreTasksViewModel](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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. + + + + +##### [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_ + + + +##### [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. + + + + +##### [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. + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md new file mode 100644 index 0000000000..3d09387b0f --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/ExploreTasksViewModel.md @@ -0,0 +1,31 @@ + + + +# ExploreTasksViewModel constructor + + + + + + + +ExploreTasksViewModel() + + + + + +## Implementation + +```dart +ExploreTasksViewModel() { + _taskService.callbackNotifyListeners = () => notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md new file mode 100644 index 0000000000..45d4afc881 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/deleteTask.md @@ -0,0 +1,44 @@ + + + +# deleteTask method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future deleteTask(String taskId, String creatorId) async { + await _taskService.deleteTask(taskId, creatorId); + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md new file mode 100644 index 0000000000..fc7f652680 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasks.md @@ -0,0 +1,44 @@ + + + +# fetchTasks method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future fetchTasks(String eventId) async { + setState(ViewState.busy); + await _taskService.getTasksForEvent(eventId); + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md new file mode 100644 index 0000000000..968e5f3742 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/fetchTasksByUser.md @@ -0,0 +1,40 @@ + + + +# fetchTasksByUser method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future fetchTasksByUser() async { + setState(ViewState.busy); + await _taskService.getTasksByUser(); + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md new file mode 100644 index 0000000000..a04396c291 --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel/tasks.md @@ -0,0 +1,35 @@ + + + +# tasks property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks + + + + + + + + +## Implementation + +```dart +List get tasks => _taskService.tasks; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model-library.md b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model-library.md new file mode 100644 index 0000000000..bdfdc5fcfa --- /dev/null +++ b/talawa-mobile-docs/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/view_model_after_auth_view_models_task_view_models_explore_tasks_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# explore_tasks_view_model library + + + + + + + + + + + +## Classes + +##### [ExploreTasksViewModel](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md) + + + +ExploreTasksViewModel class helps to interact with model to serve data +and react to user's input in Explore Task section. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md b/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md new file mode 100644 index 0000000000..873cf71cf6 --- /dev/null +++ b/talawa-mobile-docs/view_model_base_view_model/BaseModel-class.md @@ -0,0 +1,206 @@ + + + +# BaseModel class + + + + + + + + + + + + +**Inheritance** + +- [Object](https://api.flutter.dev/flutter/dart-core/Object-class.html) +- [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html) +- BaseModel + + + +**Implementers** + +- [AccessScreenViewModel](../view_model_access_request_view_model/AccessScreenViewModel-class.md) +- [AddPostViewModel](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md) +- [AppLanguage](../view_model_lang_view_model/AppLanguage-class.md) +- [AppTheme](../view_model_theme_view_model/AppTheme-class.md) +- [CommentsViewModel](../view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md) +- [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) +- [CreateTaskViewModel](../view_model_after_auth_view_models_task_view_models_create_task_view_model/CreateTaskViewModel-class.md) +- [CustomDrawerViewModel](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md) +- [DemoViewModel](../main/DemoViewModel-class.md) +- [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) +- [EditEventViewModel](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) +- [EditProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_edit_profile_view_model/EditProfilePageViewModel-class.md) +- [EventInfoViewModel](../view_model_after_auth_view_models_event_view_models_event_info_view_model/EventInfoViewModel-class.md) +- [ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) +- [ExploreTasksViewModel](../view_model_after_auth_view_models_task_view_models_explore_tasks_view_model/ExploreTasksViewModel-class.md) +- [LikeButtonViewModel](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md) +- [LoginViewModel](../view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md) +- [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) +- [OrganizationFeedViewModel](../view_model_after_auth_view_models_feed_view_models_organization_feed_view_model/OrganizationFeedViewModel-class.md) +- [ProfilePageViewModel](../view_model_after_auth_view_models_profile_view_models_profile_page_view_model/ProfilePageViewModel-class.md) +- [ProgressDialogViewModel](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md) +- [SelectContactViewModel](../view_model_after_auth_view_models_chat_view_models_select_contact_view_model/SelectContactViewModel-class.md) +- [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) +- [SetUrlViewModel](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md) +- [SignupDetailsViewModel](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md) +- [WaitingViewModel](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md) + + + + + +## Constructors + +[BaseModel](../view_model_base_view_model/BaseModel/BaseModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-only_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_base_view_model/BaseModel/BaseModel.md b/talawa-mobile-docs/view_model_base_view_model/BaseModel/BaseModel.md new file mode 100644 index 0000000000..679d13ccbc --- /dev/null +++ b/talawa-mobile-docs/view_model_base_view_model/BaseModel/BaseModel.md @@ -0,0 +1,24 @@ + + + +# BaseModel constructor + + + + + + + +BaseModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md b/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md new file mode 100644 index 0000000000..e7de222ca2 --- /dev/null +++ b/talawa-mobile-docs/view_model_base_view_model/BaseModel/isBusy.md @@ -0,0 +1,35 @@ + + + +# isBusy property + + + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isBusy + + + + + + + + +## Implementation + +```dart +bool get isBusy => _state == ViewState.busy; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md b/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md new file mode 100644 index 0000000000..a225602b83 --- /dev/null +++ b/talawa-mobile-docs/view_model_base_view_model/BaseModel/setState.md @@ -0,0 +1,37 @@ + + + +# setState method + + + + + + + + +void setState +([ViewState](../../enums_enums/ViewState.md) viewState) + + + + + + + + +## Implementation + +```dart +void setState(ViewState viewState) { + _state = viewState; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md b/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md new file mode 100644 index 0000000000..1c802c49d1 --- /dev/null +++ b/talawa-mobile-docs/view_model_base_view_model/BaseModel/state.md @@ -0,0 +1,35 @@ + + + +# state property + + + + + + + + + +[ViewState](../../enums_enums/ViewState.md) state + + + + + + + + +## Implementation + +```dart +ViewState get state => _state; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_base_view_model/view_model_base_view_model-library.md b/talawa-mobile-docs/view_model_base_view_model/view_model_base_view_model-library.md new file mode 100644 index 0000000000..95dcbc20c4 --- /dev/null +++ b/talawa-mobile-docs/view_model_base_view_model/view_model_base_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# base_view_model library + + + + + + + + + + + +## Classes + +##### [BaseModel](../view_model_base_view_model/BaseModel-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md new file mode 100644 index 0000000000..2927d291db --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage-class.md @@ -0,0 +1,292 @@ + + + +# AppLanguage class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- AppLanguage + + + + + + + + +## Constructors + +[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) + + + + +_read-only_ + + + +##### [databaseFunctions](../view_model_lang_view_model/AppLanguage/databaseFunctions.md) → [DataBaseMutationFunctions](../services_database_mutation_functions/DataBaseMutationFunctions-class.md) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [isTest](../view_model_lang_view_model/AppLanguage/isTest.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [navigationService](../view_model_lang_view_model/AppLanguage/navigationService.md) → [NavigationService](../services_navigation_service/NavigationService-class.md) + + + + +_final_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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. + + + + +##### [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> + + + +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> + + + +This function updates the Database Language by running the graphQL mutations. + + + + +##### [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_ + + + +##### [fetchLocale](../view_model_lang_view_model/AppLanguage/fetchLocale.md)() [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> + + + +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> + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [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. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + +##### [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. + + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md new file mode 100644 index 0000000000..893a5b3d79 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/AppLanguage.md @@ -0,0 +1,29 @@ + + + +# AppLanguage constructor + + + + + + + +AppLanguage({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest = false}) + + + + + +## Implementation + +```dart +AppLanguage({this.isTest = false}); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md new file mode 100644 index 0000000000..5720f3225e --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLanguageQuery.md @@ -0,0 +1,42 @@ + + + +# appLanguageQuery method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future appLanguageQuery() async { + try { + await databaseFunctions.gqlAuthQuery(queries.userLanguage()); + } catch (e) { + print(e); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md new file mode 100644 index 0000000000..6dfb7e0225 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/appLocal.md @@ -0,0 +1,35 @@ + + + +# appLocal property + + + + + + + + + +[Locale](https://api.flutter.dev/flutter/dart-ui/Locale-class.html) appLocal + + + + + + + + +## Implementation + +```dart +Locale get appLocal => _appLocale; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md new file mode 100644 index 0000000000..623634d016 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/changeLanguage.md @@ -0,0 +1,94 @@ + + + +# changeLanguage method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future changeLanguage(Locale type) async { + // if the app language is of same [type]. + if (_appLocale == type) { + return; + } + + if (isTest) { + _appLocale = type; + } else { + final prefs = await SharedPreferences.getInstance(); + 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 + _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 + _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 + _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 + _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 + _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 + _appLocale = const Locale("pt"); + await prefs.setString('language_code', 'pt'); + await prefs.setString('countryCode', 'PT'); + } else { + //If selected language is english + _appLocale = const Locale("en"); + await prefs.setString('language_code', 'en'); + await prefs.setString('countryCode', 'US'); + } + } + + /// notifying the consumers + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md new file mode 100644 index 0000000000..3d86d3cd69 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/databaseFunctions.md @@ -0,0 +1,32 @@ + + + +# databaseFunctions property + + + + + + + +[DataBaseMutationFunctions](../../services_database_mutation_functions/DataBaseMutationFunctions-class.md) databaseFunctions + +_final_ + + + + + + +## Implementation + +```dart +final databaseFunctions = locator(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md new file mode 100644 index 0000000000..82e5677ef4 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/dbLanguageUpdate.md @@ -0,0 +1,43 @@ + + + +# dbLanguageUpdate method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> dbLanguageUpdate +() + + + + + +

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

+ + + +## Implementation + +```dart +Future dbLanguageUpdate() async { + try { + await databaseFunctions + .gqlAuthMutation(queries.updateLanguage(_appLocale.languageCode)); + print('Language Updated in Database'); + } catch (e) { + print(e); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md new file mode 100644 index 0000000000..6958ea2137 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/fetchLocale.md @@ -0,0 +1,41 @@ + + + +# fetchLocale method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> fetchLocale +() + + + + + +

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

+ + + +## Implementation + +```dart +Future fetchLocale() async { + final prefs = await SharedPreferences.getInstance(); + final String langCode = prefs.getString('language_code') ?? 'en'; + _appLocale = Locale(langCode); + + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md new file mode 100644 index 0000000000..8892ae6b8f --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/initialize.md @@ -0,0 +1,37 @@ + + + +# initialize method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialize +() + + + + + + + + +## Implementation + +```dart +Future initialize() async { + _appLocale = const Locale('en'); + await fetchLocale(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md new file mode 100644 index 0000000000..e6e920cdab --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/isTest.md @@ -0,0 +1,32 @@ + + + +# isTest property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isTest + +_final_ + + + + + + +## Implementation + +```dart +final bool isTest; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md new file mode 100644 index 0000000000..e7dcec48a7 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/navigationService.md @@ -0,0 +1,32 @@ + + + +# navigationService property + + + + + + + +[NavigationService](../../services_navigation_service/NavigationService-class.md) navigationService + +_final_ + + + + + + +## Implementation + +```dart +final navigationService = locator(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md new file mode 100644 index 0000000000..22b21ec3f0 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/selectLanguagePress.md @@ -0,0 +1,44 @@ + + + +# selectLanguagePress method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future selectLanguagePress() async { + final bool userLoggedIn = await userConfig.userLoggedIn(); + if (userLoggedIn) { + dbLanguageUpdate(); + navigationService.popAndPushScreen('/appSettingsPage', arguments: ''); + } else { + navigationService.pushScreen('/setUrl', arguments: ''); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md new file mode 100644 index 0000000000..2a4c097b7d --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/AppLanguage/userLanguageQuery.md @@ -0,0 +1,46 @@ + + + +# userLanguageQuery method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future userLanguageQuery(String userId) async { + try { + await databaseFunctions.gqlAuthQuery(queries.newUserLanguage(userId)); + } catch (e) { + print(e); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_lang_view_model/view_model_lang_view_model-library.md b/talawa-mobile-docs/view_model_lang_view_model/view_model_lang_view_model-library.md new file mode 100644 index 0000000000..6ab708dcf0 --- /dev/null +++ b/talawa-mobile-docs/view_model_lang_view_model/view_model_lang_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# lang_view_model library + + + + + + + + + + + +## Classes + +##### [AppLanguage](../view_model_lang_view_model/AppLanguage-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md new file mode 100644 index 0000000000..6935ca705f --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel-class.md @@ -0,0 +1,616 @@ + + + +# MainScreenViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- MainScreenViewModel + + + + + + + + +## Constructors + +[MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel/MainScreenViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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. + + + + +##### [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) + + + +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 + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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. + + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_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 + + + +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 + + + +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) + + + +A string representation of this object. +_inherited_ + + + +##### [tourAddPost](../view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md)() void + + + +This function show the tutorial to add Post in the organization. + + + + +##### [tourChat](../view_model_main_screen_view_model/MainScreenViewModel/tourChat.md)() void + + + +This function show the tour of chats. + + + + +##### [tourEventTargets](../view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md)() void + + + +This function show the tutorial for Events. + + + + +##### [tourHomeTargets](../view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md)() void + + + +this functions starts the tour and info to be displayed is mentioned in this functions. + + + + +##### [tourProfile](../view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md)() void + + + +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) + + + +The equality operator. +_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)>> + + + +static variables. +_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)>> + + + +static variables. +_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)>> + + + +static variables. +_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)>> + + + +static variables. +_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)> + + + +static variables. +_final_ + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/MainScreenViewModel.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/MainScreenViewModel.md new file mode 100644 index 0000000000..0351920dc1 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/MainScreenViewModel.md @@ -0,0 +1,24 @@ + + + +# MainScreenViewModel constructor + + + + + + + +MainScreenViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md new file mode 100644 index 0000000000..e4087fcab8 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/context.md @@ -0,0 +1,33 @@ + + + +# context property + + + + + + + +[BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context + +_read / write_ + + + +

context consist of parent info.

+ + + +## Implementation + +```dart +late BuildContext context; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md new file mode 100644 index 0000000000..93f2952609 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/currentPageIndex.md @@ -0,0 +1,33 @@ + + + +# currentPageIndex property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex + +_read / write_ + + + +

var for current page in index.

+ + + +## Implementation + +```dart +int currentPageIndex = 0; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md new file mode 100644 index 0000000000..9e2ca01050 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/fetchAndAddPlugins.md @@ -0,0 +1,142 @@ + + + +# fetchAndAddPlugins method + + + + + + + + +void fetchAndAddPlugins +([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

+ + + +## Implementation + +```dart +void fetchAndAddPlugins( + BuildContext context, +) { + navBarItems = [ + BottomNavigationBarItem( + icon: Icon( + Icons.home, + key: keyBNHome, + ), + label: AppLocalizations.of(context)!.strictTranslate('Home'), + ), + BottomNavigationBarItem( + icon: Icon( + Icons.event_note, + key: keyBNEvents, + ), + label: AppLocalizations.of(context)!.strictTranslate('Events'), + ), + BottomNavigationBarItem( + icon: Icon( + Icons.add_box, + key: keyBNPost, + ), + label: AppLocalizations.of(context)!.strictTranslate('Add'), + ), + BottomNavigationBarItem( + icon: Icon( + Icons.chat_outlined, + key: keyBNChat, + ), + label: AppLocalizations.of(context)!.strictTranslate('Chat'), + ), + BottomNavigationBarItem( + icon: Icon( + Icons.account_circle, + key: keyBNProfile, + ), + label: AppLocalizations.of(context)!.strictTranslate('Profile'), + ) + ]; + + pages = [ + OrganizationFeed( + key: const Key("HomeView"), + homeModel: this, + ), + ExploreEvents( + key: const Key('ExploreEvents'), + homeModel: this, + ), + AddPost( + key: const Key('AddPost'), + drawerKey: MainScreenViewModel.scaffoldKey, + ), + const ChatPage( + key: Key('Chats'), + ), + ProfilePage( + key: keySPEditProfile, + homeModel: this, + ), + ]; + + pluginList = (Hive.box('pluginBox').get('plugins') ?? []) as List; + + pluginList.forEach((plugin) { + if (pluginPrototypeData.containsKey( + (plugin as Map)["pluginName"] as String, + ) && + plugin["pluginInstallStatus"] as bool) { + navBarItems.add( + BottomNavigationBarItem( + icon: Icon( + (pluginPrototypeData[plugin["pluginName"]] + as Map)["icon"] as IconData, + ), + label: AppLocalizations.of(context)!.strictTranslate( + plugin["pluginName"] as String, + ), + ), + ); + pages.add( + (pluginPrototypeData[plugin["pluginName"]] + 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) { + FetchPluginList(); + final newPluginList = + (Hive.box('pluginBox').get('plugins') ?? []) as List; + + if (listEquals(pluginList, newPluginList)) { + notifyListeners(); + } + }); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md new file mode 100644 index 0000000000..0e1e09f121 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/focusTarget.md @@ -0,0 +1,124 @@ + + + +# focusTarget method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +TargetFocus focusTarget( + GlobalKey key, + String keyName, + String description, { + bool isCircle = false, + ContentAlign align = ContentAlign.bottom, + CrossAxisAlignment crossAlign = CrossAxisAlignment.start, + Alignment skipAlignment = Alignment.topRight, + Function? next, + CrossAxisAlignment nextCrossAlign = CrossAxisAlignment.end, + bool isEnd = false, +}) { + return TargetFocus( + enableOverlayTab: true, + color: Colors.transparent, + identify: keyName, + keyTarget: key, + alignSkip: skipAlignment, + shape: isCircle ? ShapeLightFocus.Circle : ShapeLightFocus.RRect, + contents: [ + TargetContent( + align: align, + builder: (context, controller) { + return Container( + child: Column( + mainAxisSize: MainAxisSize.max, + crossAxisAlignment: crossAlign, + children: [ + Text( + description, + style: TextStyle( + color: Theme.of(context).colorScheme.background, + fontSize: 20, + ), + ), + ], + ), + ); + }, + ), + TargetContent( + align: ContentAlign.custom, + customPosition: CustomTargetContentPosition( + bottom: SizeConfig.screenHeight! * 0.025, + ), + builder: (context, controller) { + return GestureDetector( + onTap: () { + if (next != null) { + // ignore: avoid_dynamic_calls + next(); + } + tutorialCoachMark.next(); + }, + child: Column( + mainAxisSize: MainAxisSize.min, + crossAxisAlignment: nextCrossAlign, + children: [ + Text( + isEnd ? 'COMPLETE' : 'NEXT', + style: TextStyle( + color: Theme.of(context).colorScheme.background, + fontSize: 20, + ), + ), + ], + ), + ); + }, + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md new file mode 100644 index 0000000000..6f36953260 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/initialise.md @@ -0,0 +1,85 @@ + + + +# initialise method + + + + + + + + +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}) + + + + + +

Initalizing function.

+

params:

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

returns: + None

+ + + +## Implementation + +```dart +void initialise( + BuildContext ctx, { + required bool fromSignUp, + required int mainScreenIndex, +}) { + currentPageIndex = mainScreenIndex; + showAppTour = fromSignUp; + + pluginPrototypeData = { + "Donation": { + "icon": Icons.attach_money_outlined, + "page": const ChangeThemeTile(), + } + }; + + notifyListeners(); + if (!showAppTour) { + tourComplete = true; + tourSkipped = false; + } else { + Future.delayed( + const Duration(seconds: 1), + () => navigationService.pushDialog( + CustomAlertDialog( + dialogTitle: 'App Tour', + dialogSubTitle: 'Start app tour to know talawa functioning', + successText: 'Start', + secondaryButtonText: 'Skip', + success: () { + context = ctx; + navigationService.pop(); + tourHomeTargets(); + }, + secondaryButtonTap: () { + tourComplete = false; + tourSkipped = true; + notifyListeners(); + }, + ), + ), + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md new file mode 100644 index 0000000000..b879914b13 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNChat.md @@ -0,0 +1,33 @@ + + + +# keyBNChat property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keyBNChat = GlobalKey(debugLabel: "ChatTab"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md new file mode 100644 index 0000000000..e30a54fde1 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNEvents.md @@ -0,0 +1,33 @@ + + + +# keyBNEvents property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keyBNEvents = GlobalKey(debugLabel: "EventTab"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md new file mode 100644 index 0000000000..7699944053 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNHome.md @@ -0,0 +1,33 @@ + + + +# keyBNHome property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keyBNHome = GlobalKey(debugLabel: "HomeTab"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md new file mode 100644 index 0000000000..fffa669013 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNPost.md @@ -0,0 +1,33 @@ + + + +# keyBNPost property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keyBNPost = GlobalKey(debugLabel: "PostTab"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md new file mode 100644 index 0000000000..911ddc8b60 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyBNProfile.md @@ -0,0 +1,33 @@ + + + +# keyBNProfile property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keyBNProfile = GlobalKey(debugLabel: "ProfileTab"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md new file mode 100644 index 0000000000..e719516e79 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerCurOrg.md @@ -0,0 +1,34 @@ + + + +# keyDrawerCurOrg property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +static final GlobalKey keyDrawerCurOrg = + GlobalKey(debugLabel: "DrawerCurrentOrg"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md new file mode 100644 index 0000000000..384fecced5 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerJoinOrg.md @@ -0,0 +1,34 @@ + + + +# keyDrawerJoinOrg property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +static final GlobalKey keyDrawerJoinOrg = + GlobalKey(debugLabel: "DrawerJoinOrg"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md new file mode 100644 index 0000000000..1c4a7087d7 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerLeaveCurrentOrg.md @@ -0,0 +1,34 @@ + + + +# keyDrawerLeaveCurrentOrg property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +static final GlobalKey keyDrawerLeaveCurrentOrg = + GlobalKey(debugLabel: "DrawerLeaveCurrentOr"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md new file mode 100644 index 0000000000..decbb60725 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keyDrawerSwitchableOrg.md @@ -0,0 +1,34 @@ + + + +# keyDrawerSwitchableOrg property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +static final GlobalKey keyDrawerSwitchableOrg = + GlobalKey(debugLabel: "DrawerSwitchableOrg"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md new file mode 100644 index 0000000000..0644acd2de --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEAdd.md @@ -0,0 +1,33 @@ + + + +# keySEAdd property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySEAdd = GlobalKey(debugLabel: "EventScreenAdd"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md new file mode 100644 index 0000000000..52a9e67ab4 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECard.md @@ -0,0 +1,33 @@ + + + +# keySECard property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySECard = GlobalKey(debugLabel: "EventScreenCard"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md new file mode 100644 index 0000000000..729b2b95e0 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySECategoryMenu.md @@ -0,0 +1,34 @@ + + + +# keySECategoryMenu property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySECategoryMenu = + GlobalKey(debugLabel: "EventScreenCategory"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md new file mode 100644 index 0000000000..f2d5f5e1d7 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySEDateFilter.md @@ -0,0 +1,34 @@ + + + +# keySEDateFilter property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySEDateFilter = + GlobalKey(debugLabel: "EventScreenDateFilter"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md new file mode 100644 index 0000000000..89c78447f5 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHMenuIcon.md @@ -0,0 +1,33 @@ + + + +# keySHMenuIcon property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySHMenuIcon = GlobalKey(debugLabel: "HomeScreenMenuIcon"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md new file mode 100644 index 0000000000..2960a23f96 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHOrgName.md @@ -0,0 +1,33 @@ + + + +# keySHOrgName property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySHOrgName = GlobalKey(debugLabel: "HomeScreenOrgName"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md new file mode 100644 index 0000000000..3afe399432 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPinnedPost.md @@ -0,0 +1,34 @@ + + + +# keySHPinnedPost property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySHPinnedPost = + GlobalKey(debugLabel: "HomeScreenPinnedPost"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md new file mode 100644 index 0000000000..1dcf20665a --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySHPost.md @@ -0,0 +1,33 @@ + + + +# keySHPost property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySHPost = GlobalKey(debugLabel: "HomeScreenPost"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md new file mode 100644 index 0000000000..fec0020778 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPAppSetting.md @@ -0,0 +1,34 @@ + + + +# keySPAppSetting property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPAppSetting = + GlobalKey(debugLabel: "ProfileScreenAppSetting"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md new file mode 100644 index 0000000000..c912d760f5 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPDonateUs.md @@ -0,0 +1,34 @@ + + + +# keySPDonateUs property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPDonateUs = + GlobalKey(debugLabel: "ProfileScreenDonateUs"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md new file mode 100644 index 0000000000..9d406c2f98 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPEditProfile.md @@ -0,0 +1,33 @@ + + + +# keySPEditProfile property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPEditProfile = GlobalKey(debugLabel: "ProfileScreenEdit"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md new file mode 100644 index 0000000000..f1e340f212 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPHelp.md @@ -0,0 +1,33 @@ + + + +# keySPHelp property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPHelp = GlobalKey(debugLabel: "ProfileScreenHelp"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md new file mode 100644 index 0000000000..8bda57f92b --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPInvite.md @@ -0,0 +1,33 @@ + + + +# keySPInvite property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPInvite = GlobalKey(debugLabel: "ProfileScreenInvite"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md new file mode 100644 index 0000000000..4189652428 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPLogout.md @@ -0,0 +1,33 @@ + + + +# keySPLogout property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPLogout = GlobalKey(debugLabel: "ProfileScreenLogout"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md new file mode 100644 index 0000000000..71ef98a278 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/keySPPalisadoes.md @@ -0,0 +1,34 @@ + + + +# keySPPalisadoes property + + + + + + + +[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_ + + + +

static variables.

+ + + +## Implementation + +```dart +final GlobalKey keySPPalisadoes = + GlobalKey(debugLabel: "ProfileScreenPalisadoes"); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md new file mode 100644 index 0000000000..48e1b405b2 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/navBarItems.md @@ -0,0 +1,33 @@ + + + +# navBarItems property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[BottomNavigationBarItem](https://api.flutter.dev/flutter/widgets/BottomNavigationBarItem-class.html)> navBarItems + +_read / write_ + + + +

Actual BottomNavigationBarItems that show up on the screen.

+ + + +## Implementation + +```dart +List navBarItems = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md new file mode 100644 index 0000000000..7bae5460f9 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/onTabTapped.md @@ -0,0 +1,44 @@ + + + +# onTabTapped method + + + + + + + + +void onTabTapped +([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

+ + + +## Implementation + +```dart +void onTabTapped(int index) { + currentPageIndex = index; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md new file mode 100644 index 0000000000..d4bc8e82f3 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pages.md @@ -0,0 +1,34 @@ + + + +# pages property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[StatelessWidget](https://api.flutter.dev/flutter/widgets/StatelessWidget-class.html)> pages + +_read / write_ + + + +

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 = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md new file mode 100644 index 0000000000..8b7b6fca19 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginList.md @@ -0,0 +1,33 @@ + + + +# pluginList property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html) pluginList + +_read / write_ + + + +

list of all the pluginList.

+ + + +## Implementation + +```dart +List pluginList = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md new file mode 100644 index 0000000000..3974228ed0 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/pluginPrototypeData.md @@ -0,0 +1,37 @@ + + + +# pluginPrototypeData property + + + + + + + +[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html) pluginPrototypeData + +_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.

+ + + +## Implementation + +```dart +Map pluginPrototypeData = {}; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md new file mode 100644 index 0000000000..e72672b7e8 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/scaffoldKey.md @@ -0,0 +1,34 @@ + + + +# scaffoldKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)> scaffoldKey + +_final_ + + + +

static variables.

+ + + +## Implementation + +```dart +static final GlobalKey scaffoldKey = + GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md new file mode 100644 index 0000000000..a1d5c5f111 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showAppTour.md @@ -0,0 +1,33 @@ + + + +# showAppTour property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showAppTour + +_read / write_ + + + +

bool to determine if we wanna show the apptour.

+ + + +## Implementation + +```dart +late bool showAppTour; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md new file mode 100644 index 0000000000..b91cffd681 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showHome.md @@ -0,0 +1,49 @@ + + + +# showHome method + + + + + + + + +void showHome +([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

+ + + +## Implementation + +```dart +void showHome(TargetFocus clickedTarget) { + switch (clickedTarget.identify) { + case "keySHMenuIcon": + scaffoldKey.currentState!.openDrawer(); + break; + case "keyDrawerLeaveCurrentOrg": + navigationService.pop(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md new file mode 100644 index 0000000000..010e415b6b --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/showTutorial.md @@ -0,0 +1,69 @@ + + + +# showTutorial method + + + + + + + + +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()}) + + + + + +

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({ + required dynamic Function(TargetFocus) onClickTarget, + required dynamic Function() onFinish, +}) { + tutorialCoachMark = TutorialCoachMark( + targets: targets, + colorShadow: Theme.of(context).colorScheme.secondaryContainer, + textSkip: "SKIP", + textStyleSkip: TextStyle( + color: Theme.of(context).colorScheme.background, + fontSize: 20, + ), + paddingFocus: 10, + opacityShadow: 1.0, + onFinish: onFinish, + onClickTarget: onClickTarget, + onSkip: () { + if (scaffoldKey.currentState!.isDrawerOpen) { + navigationService.pop(); + } + tourSkipped = true; + onTabTapped(0); + }, + onClickOverlay: (target) { + onClickTarget(target); + }, + )..show(context: context); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md new file mode 100644 index 0000000000..1a70dc3913 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/targets.md @@ -0,0 +1,33 @@ + + + +# targets property + + + + + + + +[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_ + + + +

array of target.

+ + + +## Implementation + +```dart +final List targets = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md new file mode 100644 index 0000000000..aff76a5563 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourAddPost.md @@ -0,0 +1,59 @@ + + + +# tourAddPost method + + + + + + + + +void tourAddPost +() + + + + + +

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

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void tourAddPost() { + targets.clear(); + targets.add( + focusTarget( + keyBNPost, + 'keyBNPost', + 'This is the Create post tab here you can add post to the current selected organization', + isCircle: true, + align: ContentAlign.top, + ), + ); + showTutorial( + onFinish: () { + onTabTapped(currentPageIndex + 1); + if (!tourComplete && !tourSkipped) { + tourChat(); + } + }, + onClickTarget: (TargetFocus a) {}, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md new file mode 100644 index 0000000000..9386279f52 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourChat.md @@ -0,0 +1,59 @@ + + + +# tourChat method + + + + + + + + +void tourChat +() + + + + + +

This function show the tour of chats.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void tourChat() { + targets.clear(); + targets.add( + focusTarget( + keyBNChat, + 'keyBNChat', + 'This is the Chat tab here you can see all your messages of the current selected organization', + isCircle: true, + align: ContentAlign.top, + ), + ); + showTutorial( + onFinish: () { + onTabTapped(currentPageIndex + 1); + if (!tourComplete && !tourSkipped) { + tourProfile(); + } + }, + onClickTarget: (TargetFocus a) {}, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md new file mode 100644 index 0000000000..f95abfaf6d --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourComplete.md @@ -0,0 +1,33 @@ + + + +# tourComplete property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) tourComplete + +_read / write_ + + + +

bool to determine if apptour is complete.

+ + + +## Implementation + +```dart +bool tourComplete = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md new file mode 100644 index 0000000000..35a5377474 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourEventTargets.md @@ -0,0 +1,88 @@ + + + +# tourEventTargets method + + + + + + + + +void tourEventTargets +() + + + + + +

This function show the tutorial for Events.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void tourEventTargets() { + targets.clear(); + targets.add( + focusTarget( + keyBNEvents, + 'keyBNEvents', + 'This is the Events tab here you can see all event related information of the current selected organization', + isCircle: true, + align: ContentAlign.top, + ), + ); + targets.add( + focusTarget( + keySECategoryMenu, + 'keySECategoryMenu', + 'Filter Events based on categories', + ), + ); + targets.add( + focusTarget( + keySEDateFilter, + 'keySEDateFilter', + 'Filter Events between selected dates', + ), + ); + targets.add( + focusTarget( + keySECard, + 'keySECard', + 'Description of event to see more details click on the card', + ), + ); + targets.add( + focusTarget( + keySEAdd, + 'keySEAdd', + 'You can create a new event from here', + align: ContentAlign.top, + ), + ); + showTutorial( + onFinish: () { + onTabTapped(currentPageIndex + 1); + if (!tourComplete && !tourSkipped) { + tourAddPost(); + } + }, + onClickTarget: (TargetFocus a) {}, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md new file mode 100644 index 0000000000..8a9dbd83ba --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourHomeTargets.md @@ -0,0 +1,122 @@ + + + +# tourHomeTargets method + + + + + + + + +void tourHomeTargets +() + + + + + +

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

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void tourHomeTargets() { + targets.clear(); + targets.add( + focusTarget( + keySHOrgName, + 'keySHOrgName', + 'Current selected Organization Name', + ), + ); + targets.add( + focusTarget( + keySHMenuIcon, + 'keySHMenuIcon', + 'Click this button to see options related to switching, joining and leaving organization(s)', + isCircle: true, + next: () => scaffoldKey.currentState!.openDrawer(), + ), + ); + targets.add( + focusTarget( + keyDrawerCurOrg, + 'keyDrawerCurOrg', + "Current selected Organization's Name appears here", + ), + ); + targets.add( + focusTarget( + keyDrawerSwitchableOrg, + 'keyDrawerSwitchableOrg', + "All your joined organizations appear over here you can click on them to change the current organization", + ), + ); + targets.add( + focusTarget( + keyDrawerJoinOrg, + 'keyDrawerJoinOrg', + "From this button you can join other listed organizations", + align: ContentAlign.top, + ), + ); + targets.add( + focusTarget( + keyDrawerLeaveCurrentOrg, + 'keyDrawerLeaveCurrentOrg', + "To leave the current organization you can use this option", + align: ContentAlign.top, + next: () => navigationService.pop(), + ), + ); + targets.add( + focusTarget( + keyBNHome, + 'keyBNHome', + "This is the home tab here you can see the latest post from other members of the current organization", + isCircle: true, + align: ContentAlign.top, + ), + ); + targets.add( + focusTarget( + keySHPinnedPost, + 'keySHPinnedPost', + "This section displays all the important post set by the organization admin(s)", + align: ContentAlign.bottom, + ), + ); + targets.add( + focusTarget( + keySHPost, + 'keySHPost', + "This is the post card you can like and comment on the post from the options available", + align: ContentAlign.bottom, + ), + ); + showTutorial( + onClickTarget: showHome, + onFinish: () { + onTabTapped(currentPageIndex + 1); + if (!tourComplete && !tourSkipped) { + tourEventTargets(); + } + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md new file mode 100644 index 0000000000..9aae9bc648 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourProfile.md @@ -0,0 +1,96 @@ + + + +# tourProfile method + + + + + + + + +void tourProfile +() + + + + + +

This function show the tutorial for the profile page.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +void tourProfile() { + targets.clear(); + targets.add( + focusTarget( + keyBNProfile, + 'keyBNProfile', + 'This is the Profile tab here you can see all options related to account, app setting, invitation, help etc', + isCircle: true, + align: ContentAlign.top, + nextCrossAlign: CrossAxisAlignment.start, + ), + ); + targets.add( + focusTarget( + keySPAppSetting, + 'keySPAppSetting', + 'You can edit application settings like language, theme etc from here', + ), + ); + targets.add( + focusTarget( + keySPHelp, + 'keySPHelp', + 'For any help we are always there. You can reach us from here', + ), + ); + targets.add( + focusTarget( + keySPDonateUs, + 'keySPDonateUs', + 'To help your organization grow you can support them financially from here', + ), + ); + targets.add( + focusTarget( + keySPInvite, + 'keySPInvite', + 'Wanna invite colleague, invite them from here', + ), + ); + targets.add( + focusTarget( + keySPPalisadoes, + 'keySPPalisadoes', + 'You are all set to go lets get you in', + isEnd: true, + ), + ); + showTutorial( + onFinish: () { + if (!tourComplete && !tourSkipped) { + tourComplete = true; + onTabTapped(0); + } + }, + onClickTarget: (TargetFocus a) {}, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md new file mode 100644 index 0000000000..46465249e3 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tourSkipped.md @@ -0,0 +1,33 @@ + + + +# tourSkipped property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) tourSkipped + +_read / write_ + + + +

bool to determine if apptour is skipped.

+ + + +## Implementation + +```dart +bool tourSkipped = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md new file mode 100644 index 0000000000..e6c7406f7e --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/MainScreenViewModel/tutorialCoachMark.md @@ -0,0 +1,33 @@ + + + +# tutorialCoachMark property + + + + + + + +[TutorialCoachMark](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark + +_read / write_ + + + +

tutorialCoachMark consist of coach used to give tutorial.

+ + + +## Implementation + +```dart +late TutorialCoachMark tutorialCoachMark; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_main_screen_view_model/view_model_main_screen_view_model-library.md b/talawa-mobile-docs/view_model_main_screen_view_model/view_model_main_screen_view_model-library.md new file mode 100644 index 0000000000..5d8d533241 --- /dev/null +++ b/talawa-mobile-docs/view_model_main_screen_view_model/view_model_main_screen_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# main_screen_view_model library + + + + + + + + + + + +## Classes + +##### [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) + + + +MainScreenViewModel class provide methods to interact with the modal to serve data in user's action in Main Screen Views. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md new file mode 100644 index 0000000000..c2c1a9d099 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md @@ -0,0 +1,275 @@ + + + +# LoginViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- LoginViewModel + + + + + + + + +## Constructors + +[LoginViewModel](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/LoginViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [validate](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md) ↔ [AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [initialize](../view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md)() 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> + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/LoginViewModel.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/LoginViewModel.md new file mode 100644 index 0000000000..c37c0bbc5c --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/LoginViewModel.md @@ -0,0 +1,24 @@ + + + +# LoginViewModel constructor + + + + + + + +LoginViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md new file mode 100644 index 0000000000..8fc948122f --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/email.md @@ -0,0 +1,32 @@ + + + +# email property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) email + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController email = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md new file mode 100644 index 0000000000..ecd01d588e --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/emailFocus.md @@ -0,0 +1,32 @@ + + + +# emailFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) emailFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode emailFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md new file mode 100644 index 0000000000..d7de0e859a --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/formKey.md @@ -0,0 +1,32 @@ + + + +# formKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey + +_final_ + + + + + + +## Implementation + +```dart +final formKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md new file mode 100644 index 0000000000..de486919b3 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/greeting.md @@ -0,0 +1,32 @@ + + + +# greeting property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +late List> greeting; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md new file mode 100644 index 0000000000..bd2ce20b96 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/hidePassword.md @@ -0,0 +1,32 @@ + + + +# hidePassword property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) hidePassword + +_read / write_ + + + + + + +## Implementation + +```dart +bool hidePassword = true; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md new file mode 100644 index 0000000000..048ef7ef85 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/initialize.md @@ -0,0 +1,64 @@ + + + +# initialize method + + + + + + + + +void initialize +() + + + + + + + + +## Implementation + +```dart +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/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md new file mode 100644 index 0000000000..dc101fdbe2 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/login.md @@ -0,0 +1,107 @@ + + + +# login method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> login +() + + + + + +

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

+ + + +## Implementation + +```dart +Future login() async { + emailFocus.unfocus(); + passwordFocus.unfocus(); + validate = AutovalidateMode.always; + // 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`. + final result = await databaseFunctions + .gqlNonAuthMutation(queries.loginUser(email.text, password.text)); + navigationService.pop(); + // if user found. + if (result != null) { + final User loggedInUser = + User.fromJson(result.data!['login'] as Map); + userConfig.updateUser(loggedInUser); + // if user has not already joined any organization. + if (userConfig.currentUser.joinedOrganizations!.isEmpty) { + navigationService.removeAllAndPush( + Routes.waitingScreen, + Routes.splashScreen, + ); + } else { + userConfig.saveCurrentOrgInHive( + userConfig.currentUser.joinedOrganizations![0], + ); + navigationService.removeAllAndPush( + Routes.mainScreen, + Routes.splashScreen, + arguments: MainScreenArgs(mainScreenIndex: 0, fromSignUp: false), + ); + } + final loginResult = result.data['login'] as Map; + androidFirebaseOptions = + loginResult['androidFirebaseOptions'] as Map; + iosFirebaseOptions = + loginResult['iosFirebaseOptions'] as Map; + if (androidFirebaseOptions['apiKey'] != null || + iosFirebaseOptions['apiKey'] != null) { + await setUpFirebase(); + + final token = await FirebaseMessaging.instance.getToken(); + await databaseFunctions.gqlAuthMutation( + queries.saveFcmToken(token), + ); + + await setUpFirebaseMessaging(); + + final androidFirebaseOptionsBox = + await Hive.openBox('androidFirebaseOptions'); + androidFirebaseOptionsBox.put( + 'androidFirebaseOptions', + androidFirebaseOptions, + ); + + final iosFirebaseOptionsBox = + await Hive.openBox('iosFirebaseOptions'); + iosFirebaseOptionsBox.put( + 'iosFirebaseOptions', + iosFirebaseOptions, + ); + } + } + } on Exception catch (e) { + print('here'); + print(e); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md new file mode 100644 index 0000000000..b344a9fede --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/password.md @@ -0,0 +1,32 @@ + + + +# password property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) password + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController password = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md new file mode 100644 index 0000000000..2b7716a5dc --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/passwordFocus.md @@ -0,0 +1,32 @@ + + + +# passwordFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) passwordFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode passwordFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md new file mode 100644 index 0000000000..7dd63a4d44 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/LoginViewModel/validate.md @@ -0,0 +1,32 @@ + + + +# validate property + + + + + + + +[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate + +_read / write_ + + + + + + +## Implementation + +```dart +AutovalidateMode validate = AutovalidateMode.disabled; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/view_model_pre_auth_view_models_login_view_model-library.md b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/view_model_pre_auth_view_models_login_view_model-library.md new file mode 100644 index 0000000000..b183f6c11a --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_login_view_model/view_model_pre_auth_view_models_login_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# login_view_model library + + + + + + + + + + + +## Classes + +##### [LoginViewModel](../view_model_pre_auth_view_models_login_view_model/LoginViewModel-class.md) + + + +LoginViewModel class helps to interact with model to serve data +and react to user's input in Login View. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md new file mode 100644 index 0000000000..f7fa3a76d4 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md @@ -0,0 +1,340 @@ + + + +# SelectOrganizationViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- SelectOrganizationViewModel + + + + + + + + +## Constructors + +[SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/SelectOrganizationViewModel.md) () + + + + +## 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) + + + + +_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) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [selectedOrganization](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_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) + + + + +_read / write_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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 + + + +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> + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [onTapContinue](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md)() 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. + + + + +##### [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_ + + + +##### [searchActive](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md)() 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> + + + +This function select the organization. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/SelectOrganizationViewModel.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/SelectOrganizationViewModel.md new file mode 100644 index 0000000000..a03045c935 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/SelectOrganizationViewModel.md @@ -0,0 +1,24 @@ + + + +# SelectOrganizationViewModel constructor + + + + + + + +SelectOrganizationViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md new file mode 100644 index 0000000000..0e3bcabd30 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/allOrgController.md @@ -0,0 +1,32 @@ + + + +# allOrgController property + + + + + + + +[ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) allOrgController + +_final_ + + + + + + +## Implementation + +```dart +final ScrollController allOrgController = ScrollController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md new file mode 100644 index 0000000000..00b8f4d3b3 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/controller.md @@ -0,0 +1,32 @@ + + + +# controller property + + + + + + + +[ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) controller + +_final_ + + + + + + +## Implementation + +```dart +final ScrollController controller = ScrollController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md new file mode 100644 index 0000000000..e7c1a59725 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/fetchMoreHelper.md @@ -0,0 +1,52 @@ + + + +# fetchMoreHelper method + + + + + + + + +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) + + + + + +

This function fetch more option.

+ + + +## Implementation + +```dart +void fetchMoreHelper(FetchMore fetchMore, List organizations) { + fetchMore( + FetchMoreOptions( + variables: { + "first": organizations.length + 15, + "skip": organizations.length, + }, + updateQuery: (existingOrganizations, newOrganizations) { + return { + 'organizationsConnection': [ + ...existingOrganizations!["organizationsConnection"], + ...newOrganizations!['organizationsConnection'], + ], + }; + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md new file mode 100644 index 0000000000..a13f60bf16 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/initialise.md @@ -0,0 +1,52 @@ + + + +# initialise method + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +Future initialise(String initialData) async { + searchFocus.addListener(searchActive); + if (!initialData.contains('-1')) { + databaseFunctions.init(); + final fetch = await databaseFunctions.fetchOrgById(initialData); + if (fetch.runtimeType == OrgInfo) { + selectedOrganization = fetch as OrgInfo; + if (userConfig.currentUser.refreshToken?.isEmpty ?? true) { + navigationService.pushScreen( + Routes.signupDetailScreen, + arguments: selectedOrganization, + ); + } else { + selectOrg(selectedOrganization); + } + setState(ViewState.idle); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md new file mode 100644 index 0000000000..916f8b18a0 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapContinue.md @@ -0,0 +1,48 @@ + + + +# onTapContinue method + + + + + + + + +void onTapContinue +() + + + + + + + + +## Implementation + +```dart +void onTapContinue() { + // if user selected any organization. + if (selectedOrganization.id != '-1') { + navigationService.pushScreen( + Routes.signupDetailScreen, + arguments: selectedOrganization, + ); + } else { + navigationService.showTalawaErrorSnackBar( + 'Select one organization to continue', + MessageType.warning, + duration: const Duration(milliseconds: 750), + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md new file mode 100644 index 0000000000..c132332371 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/onTapJoin.md @@ -0,0 +1,88 @@ + + + +# onTapJoin method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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 = + ((result.data!['joinPublicOrganization'] + 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) { + userConfig.saveCurrentOrgInHive( + userConfig.currentUser.joinedOrganizations![0], + ); + navigationService.removeAllAndPush( + Routes.mainScreen, + Routes.splashScreen, + arguments: MainScreenArgs(mainScreenIndex: 0), + ); + } else { + navigationService.pop(); + navigationService.showTalawaErrorSnackBar( + 'Joined ${selectedOrganization.name} successfully', + MessageType.info, + ); + } + } 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/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md new file mode 100644 index 0000000000..8401c3532a --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/orgId.md @@ -0,0 +1,32 @@ + + + +# orgId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId + +_read / write_ + + + + + + +## Implementation + +```dart +late String orgId; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md new file mode 100644 index 0000000000..d267d675bd --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/organizations.md @@ -0,0 +1,32 @@ + + + +# organizations property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> organizations + +_read / write_ + + + + + + +## Implementation + +```dart +late List organizations = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md new file mode 100644 index 0000000000..1106a10ec0 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/qrKey.md @@ -0,0 +1,32 @@ + + + +# qrKey property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +final GlobalKey qrKey = GlobalKey(debugLabel: 'QR'); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md new file mode 100644 index 0000000000..9e5c1d6a2b --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/result.md @@ -0,0 +1,32 @@ + + + +# result property + + + + + + + +[Barcode](https://pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) result + +_read / write_ + + + + + + +## Implementation + +```dart +late Barcode result; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md new file mode 100644 index 0000000000..da4b165c2d --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchActive.md @@ -0,0 +1,40 @@ + + + +# searchActive method + + + + + + + + +void searchActive +() + + + + + + + + +## Implementation + +```dart +void searchActive() { + if (searchFocus.hasFocus) { + organizations = []; + searching = true; + setState(ViewState.idle); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md new file mode 100644 index 0000000000..5f278031af --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchController.md @@ -0,0 +1,32 @@ + + + +# searchController property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) searchController + +_final_ + + + + + + +## Implementation + +```dart +final TextEditingController searchController = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md new file mode 100644 index 0000000000..a2cadd5256 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searchFocus.md @@ -0,0 +1,32 @@ + + + +# searchFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) searchFocus + +_final_ + + + + + + +## Implementation + +```dart +final FocusNode searchFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md new file mode 100644 index 0000000000..427df2c30f --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/searching.md @@ -0,0 +1,32 @@ + + + +# searching property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) searching + +_read / write_ + + + + + + +## Implementation + +```dart +bool searching = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md new file mode 100644 index 0000000000..6a6ccd37b0 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectOrg.md @@ -0,0 +1,91 @@ + + + +# selectOrg method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +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) { + 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) { + orgRequestAlreadyPresent = true; + } + }); + // if not already joined and not memebrship request. + if (!orgAlreadyJoined && !orgRequestAlreadyPresent) { + selectedOrganization = item; + notifyListeners(); + onTapJoin(); + // print(selectedOrganization.isPublic); + + if (!selectedOrganization.isPublic!) { + navigationService.pushScreen( + Routes.requestAccess, + arguments: selectedOrganization, + ); + } + } else if (orgAlreadyJoined) { + selectedOrganization = OrgInfo(id: '-1'); + navigationService.showTalawaErrorSnackBar( + 'Organisation already joined', + MessageType.warning, + ); + } else { + navigationService.showTalawaErrorSnackBar( + 'Membership request already sent', + MessageType.warning, + ); + } + } else { + selectedOrganization = item; + notifyListeners(); + navigationService.pushScreen( + Routes.signupDetailScreen, + arguments: selectedOrganization, + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md new file mode 100644 index 0000000000..1c7a65ca8a --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/selectedOrganization.md @@ -0,0 +1,32 @@ + + + +# selectedOrganization property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrganization + +_read / write_ + + + + + + +## Implementation + +```dart +late OrgInfo selectedOrganization = OrgInfo(id: '-1'); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md new file mode 100644 index 0000000000..c8c83bdd4d --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel/showSearchOrgList.md @@ -0,0 +1,32 @@ + + + +# showSearchOrgList property + + + + + + + +[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) showSearchOrgList + +_read / write_ + + + + + + +## Implementation + +```dart +late Widget showSearchOrgList = Container(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/view_model_pre_auth_view_models_select_organization_view_model-library.md b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/view_model_pre_auth_view_models_select_organization_view_model-library.md new file mode 100644 index 0000000000..074705cdc6 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_select_organization_view_model/view_model_pre_auth_view_models_select_organization_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# select_organization_view_model library + + + + + + + + + + + +## Classes + +##### [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) + + + +SelectOrganizationViewModel class helps to interact with model to serve data +and react to user's input in Select Organization View. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md new file mode 100644 index 0000000000..eea1cc27f4 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md @@ -0,0 +1,319 @@ + + + +# SetUrlViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- SetUrlViewModel + + + + + + + + +## Constructors + +[SetUrlViewModel](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/SetUrlViewModel.md) () + + + + +## 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. +_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>> + + + +qrController. +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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> + + + +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> + + + +This function check the URL and navigate to the respective URL. + + + + +##### [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_ + + + +##### [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 + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [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 + + + +This function create a widget which is used to scan the QR-code. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_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. + + + + +##### [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. + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/SetUrlViewModel.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/SetUrlViewModel.md new file mode 100644 index 0000000000..e77e026ae8 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/SetUrlViewModel.md @@ -0,0 +1,24 @@ + + + +# SetUrlViewModel constructor + + + + + + + +SetUrlViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md new file mode 100644 index 0000000000..3d400b2576 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandNavigate.md @@ -0,0 +1,72 @@ + + + +# checkURLandNavigate method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future checkURLandNavigate(String navigateTo, String argument) async { + urlFocus.unfocus(); + validate = AutovalidateMode.always; + + /// 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) { + final box = Hive.box('url'); + box.put(urlKey, uri); + box.put(imageUrlKey, "$uri/talawa/"); + + navigationService.pop(); + graphqlConfig.getOrgUrl(); + navigationService.pushScreen(navigateTo, arguments: argument); + } else { + navigationService.pop(); + navigationService.showTalawaErrorSnackBar( + "URL doesn't exist/no connection please check", + MessageType.error, + ); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md new file mode 100644 index 0000000000..bdfe2ca461 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/checkURLandShowPopUp.md @@ -0,0 +1,73 @@ + + + +# checkURLandShowPopUp method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Future checkURLandShowPopUp(String argument) async { + urlFocus.unfocus(); + validate = AutovalidateMode.always; + + // 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) { + final box = Hive.box('url'); + box.put(urlKey, uri); + box.put(imageUrlKey, "$uri/talawa/"); + navigationService.pop(); + graphqlConfig.getOrgUrl(); + navigationService.showSnackBar("Url is valid"); + } else { + navigationService.pop(); + navigationService.showTalawaErrorDialog( + "URL doesn't exist/no connection please check", + MessageType.info, + ); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md new file mode 100644 index 0000000000..dc694cea69 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/formKey.md @@ -0,0 +1,33 @@ + + + +# formKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey + +_final_ + + + +

formKey.

+ + + +## Implementation + +```dart +final formKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md new file mode 100644 index 0000000000..3c142332fd --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/greeting.md @@ -0,0 +1,33 @@ + + + +# greeting property + + + + + + + +[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_ + + + +

qrController.

+ + + +## Implementation + +```dart +late List> greeting; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md new file mode 100644 index 0000000000..6c8a4090ae --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/imageUrlKey-constant.md @@ -0,0 +1,33 @@ + + + +# imageUrlKey constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const imageUrlKey + + + + + +

imageUrlKey.

+ + + +## Implementation + +```dart +static const imageUrlKey = "imageUrl"; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md new file mode 100644 index 0000000000..828addb8fa --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/initialise.md @@ -0,0 +1,89 @@ + + + +# initialise method + + + + + + + + +void initialise +({[String](https://api.flutter.dev/flutter/dart-core/String-class.html) inviteUrl = ''}) + + + + + +

This function initialises the variables.

+

params:

+
    +
  • inviteUrl: url
  • +
+

returns: + None

+ + + +## Implementation + +```dart +void initialise({String inviteUrl = ''}) { + final uri = inviteUrl; + 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 = [ + { + '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/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md new file mode 100644 index 0000000000..0dd4df4332 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/orgId.md @@ -0,0 +1,33 @@ + + + +# orgId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId + +_read / write_ + + + +

organizationID.

+ + + +## Implementation + +```dart +String orgId = '-1'; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md new file mode 100644 index 0000000000..911a3ddbb5 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/qrKey.md @@ -0,0 +1,33 @@ + + + +# qrKey property + + + + + + + +[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_ + + + +

qrKey.

+ + + +## Implementation + +```dart +final GlobalKey qrKey = GlobalKey(debugLabel: 'QR'); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md new file mode 100644 index 0000000000..e23ab60614 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/result.md @@ -0,0 +1,33 @@ + + + +# result property + + + + + + + +[Barcode](https://pub.dev/documentation/qr_code_scanner/1.0.1/qr_code_scanner/Barcode-class.html) result + +_read / write_ + + + +

qrText.

+ + + +## Implementation + +```dart +late Barcode result; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md new file mode 100644 index 0000000000..ead578be17 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/scanQR.md @@ -0,0 +1,93 @@ + + + +# scanQR method + + + + + + + + +void scanQR +([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

+ + + +## Implementation + +```dart +void scanQR(BuildContext context) { + showModalBottomSheet( + context: context, + barrierColor: Colors.transparent, + shape: const RoundedRectangleBorder( + borderRadius: BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + ), + builder: (BuildContext context) { + return ClipRRect( + borderRadius: const BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + child: Container( + height: MediaQuery.of(context).size.width, + decoration: BoxDecoration( + color: Theme.of(context).colorScheme.secondary, + ), + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + SizedBox( + height: 250, + width: 250, + child: QRView( + key: qrKey, + onQRViewCreated: _onQRViewCreated, + overlay: QrScannerOverlayShape( + borderRadius: 10, + borderLength: 20, + borderWidth: 10, + cutOutSize: 250, + ), + /*overlayMargin: EdgeInsets.all(50)*/ + ), + ), + SizedBox( + height: SizeConfig.safeBlockVertical! * 4, + ), + const Text('Scan QR'), + SizedBox( + height: SizeConfig.safeBlockVertical! * 4, + ) + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md new file mode 100644 index 0000000000..2f3e57fc87 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/url.md @@ -0,0 +1,33 @@ + + + +# url property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) url + +_read / write_ + + + +

url.

+ + + +## Implementation + +```dart +TextEditingController url = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md new file mode 100644 index 0000000000..bc8e159cf7 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlFocus.md @@ -0,0 +1,33 @@ + + + +# urlFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) urlFocus + +_read / write_ + + + +

urlFocus.

+ + + +## Implementation + +```dart +FocusNode urlFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md new file mode 100644 index 0000000000..3e462eee9d --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/urlKey-constant.md @@ -0,0 +1,33 @@ + + + +# urlKey constant + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) const urlKey + + + + + +

urlKey.

+ + + +## Implementation + +```dart +static const urlKey = "url"; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md new file mode 100644 index 0000000000..4c75388901 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel/validate.md @@ -0,0 +1,33 @@ + + + +# validate property + + + + + + + +[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate + +_read / write_ + + + +

qrValidator.

+ + + +## Implementation + +```dart +AutovalidateMode validate = AutovalidateMode.disabled; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/view_model_pre_auth_view_models_set_url_view_model-library.md b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/view_model_pre_auth_view_models_set_url_view_model-library.md new file mode 100644 index 0000000000..040465868d --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_set_url_view_model/view_model_pre_auth_view_models_set_url_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# set_url_view_model library + + + + + + + + + + + +## Classes + +##### [SetUrlViewModel](../view_model_pre_auth_view_models_set_url_view_model/SetUrlViewModel-class.md) + + + +SetUrlViewModel class helps to interact with model to serve data. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md new file mode 100644 index 0000000000..68a80ada53 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md @@ -0,0 +1,303 @@ + + + +# SignupDetailsViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- SignupDetailsViewModel + + + + + + + + +## Constructors + +[SignupDetailsViewModel](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/SignupDetailsViewModel.md) () + + + + +## 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) + + + + +_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) + + + + +_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) + + + + +_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) + + + + +_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)> + + + + +_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>> + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [selectedOrganization](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md) ↔ [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_read / write_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [initialise](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) org) void + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_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> + + + +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. + + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/SignupDetailsViewModel.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/SignupDetailsViewModel.md new file mode 100644 index 0000000000..de1282e245 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/SignupDetailsViewModel.md @@ -0,0 +1,24 @@ + + + +# SignupDetailsViewModel constructor + + + + + + + +SignupDetailsViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md new file mode 100644 index 0000000000..66b9c41cbf --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmFocus.md @@ -0,0 +1,32 @@ + + + +# confirmFocus property + + + + + + + +[FocusNode](https://api.flutter.dev/flutter/widgets/FocusNode-class.html) confirmFocus + +_read / write_ + + + + + + +## Implementation + +```dart +FocusNode confirmFocus = FocusNode(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md new file mode 100644 index 0000000000..be24345f1f --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/confirmPassword.md @@ -0,0 +1,32 @@ + + + +# confirmPassword property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) confirmPassword + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController confirmPassword = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md new file mode 100644 index 0000000000..8fc948122f --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/email.md @@ -0,0 +1,32 @@ + + + +# email property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) email + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController email = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md new file mode 100644 index 0000000000..05e3d39ab1 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/firstName.md @@ -0,0 +1,32 @@ + + + +# firstName property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) firstName + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController firstName = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md new file mode 100644 index 0000000000..d7de0e859a --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/formKey.md @@ -0,0 +1,32 @@ + + + +# formKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[FormState](https://api.flutter.dev/flutter/widgets/FormState-class.html)> formKey + +_final_ + + + + + + +## Implementation + +```dart +final formKey = GlobalKey(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md new file mode 100644 index 0000000000..de486919b3 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/greeting.md @@ -0,0 +1,32 @@ + + + +# greeting property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +late List> greeting; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md new file mode 100644 index 0000000000..bd2ce20b96 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/hidePassword.md @@ -0,0 +1,32 @@ + + + +# hidePassword property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) hidePassword + +_read / write_ + + + + + + +## Implementation + +```dart +bool hidePassword = true; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md new file mode 100644 index 0000000000..eb0ac9473e --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/initialise.md @@ -0,0 +1,64 @@ + + + +# initialise method + + + + + + + + +void initialise +([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org) + + + + + + + + +## Implementation + +```dart +void initialise(OrgInfo org) { + selectedOrganization = org; + // 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/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md new file mode 100644 index 0000000000..7f599f4922 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/lastName.md @@ -0,0 +1,32 @@ + + + +# lastName property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) lastName + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController lastName = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md new file mode 100644 index 0000000000..b344a9fede --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/password.md @@ -0,0 +1,32 @@ + + + +# password property + + + + + + + +[TextEditingController](https://api.flutter.dev/flutter/widgets/TextEditingController-class.html) password + +_read / write_ + + + + + + +## Implementation + +```dart +TextEditingController password = TextEditingController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md new file mode 100644 index 0000000000..627e15c4da --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/selectedOrganization.md @@ -0,0 +1,32 @@ + + + +# selectedOrganization property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrganization + +_read / write_ + + + + + + +## Implementation + +```dart +late OrgInfo selectedOrganization; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md new file mode 100644 index 0000000000..a21b802c3b --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/signUp.md @@ -0,0 +1,128 @@ + + + +# signUp method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Future signUp() async { + FocusScope.of(navigationService.navigatorKey.currentContext!).unfocus(); + setState(ViewState.busy); + validate = AutovalidateMode.always; + setState(ViewState.idle); + if (formKey.currentState!.validate()) { + validate = AutovalidateMode.disabled; + navigationService + .pushDialog(const CustomProgressDialog(key: Key('SignUpProgress'))); + databaseFunctions.init(); + try { + final result = await databaseFunctions.gqlNonAuthMutation( + queries.registerUser( + firstName.text, + lastName.text, + email.text, + password.text, + ), + ); + navigationService.pop(); + if (result != null) { + final User signedInUser = + 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 { + final QueryResult result = + await databaseFunctions.gqlAuthMutation( + queries.joinOrgById(selectedOrganization.id!), + ) as QueryResult; + + final List? joinedOrg = (result + .data!['joinPublicOrganization'] + ['joinedOrganizations'] as List?) + ?.map((e) => OrgInfo.fromJson(e as Map)) + .toList(); + userConfig.updateUserJoinedOrg(joinedOrg!); + userConfig.saveCurrentOrgInHive( + userConfig.currentUser.joinedOrganizations![0], + ); + navigationService.removeAllAndPush( + Routes.mainScreen, + Routes.splashScreen, + arguments: + MainScreenArgs(mainScreenIndex: 0, fromSignUp: true), + ); + } on Exception catch (e) { + print(e); + navigationService.showTalawaErrorSnackBar( + 'SomeThing went wrong', + MessageType.error, + ); + } + } else { + try { + final QueryResult result = + await databaseFunctions.gqlAuthMutation( + queries.sendMembershipRequest(selectedOrganization.id!), + ) as QueryResult; + + final OrgInfo membershipRequest = OrgInfo.fromJson( + result.data!['sendMembershipRequest']['organization'] + as Map, + ); + userConfig.updateUserMemberRequestOrg([membershipRequest]); + navigationService.pop(); + navigationService.removeAllAndPush( + Routes.waitingScreen, + Routes.splashScreen, + ); + } on Exception catch (e) { + print(e); + navigationService.showTalawaErrorSnackBar( + 'SomeThing went wrong', + MessageType.error, + ); + } + } + } + } + } on Exception catch (e) { + print(e); + navigationService.showTalawaErrorSnackBar( + 'SomeThing went wrong', + MessageType.error, + ); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md new file mode 100644 index 0000000000..7dd63a4d44 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel/validate.md @@ -0,0 +1,32 @@ + + + +# validate property + + + + + + + +[AutovalidateMode](https://api.flutter.dev/flutter/widgets/AutovalidateMode.html) validate + +_read / write_ + + + + + + +## Implementation + +```dart +AutovalidateMode validate = AutovalidateMode.disabled; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/view_model_pre_auth_view_models_signup_details_view_model-library.md b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/view_model_pre_auth_view_models_signup_details_view_model-library.md new file mode 100644 index 0000000000..24e8f4fda8 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_signup_details_view_model/view_model_pre_auth_view_models_signup_details_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# signup_details_view_model library + + + + + + + + + + + +## Classes + +##### [SignupDetailsViewModel](../view_model_pre_auth_view_models_signup_details_view_model/SignupDetailsViewModel-class.md) + + + +SignupDetailsViewModel class helps to interact with model to serve data +and react to user's input for Sign Up Details section. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md new file mode 100644 index 0000000000..71a25decac --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md @@ -0,0 +1,239 @@ + + + +# WaitingViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- WaitingViewModel + + + + + + + + +## Constructors + +[WaitingViewModel](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/WaitingViewModel.md) () + + + + +## Properties + +##### [currentUser](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md) ↔ [User](../models_user_user_info/User-class.md) + + + + +_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>> + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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 + + + + + + + + +##### [joinOrg](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md)() void + + + + + + + + +##### [logout](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md)() void + + + +This function ends the session for the user or logout the user from the 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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/WaitingViewModel.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/WaitingViewModel.md new file mode 100644 index 0000000000..127dbe8ba7 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/WaitingViewModel.md @@ -0,0 +1,24 @@ + + + +# WaitingViewModel constructor + + + + + + + +WaitingViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md new file mode 100644 index 0000000000..e955d40624 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/currentUser.md @@ -0,0 +1,32 @@ + + + +# currentUser property + + + + + + + +[User](../../models_user_user_info/User-class.md) currentUser + +_read / write_ + + + + + + +## Implementation + +```dart +late User currentUser; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md new file mode 100644 index 0000000000..de486919b3 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/greeting.md @@ -0,0 +1,32 @@ + + + +# greeting property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +late List> greeting; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md new file mode 100644 index 0000000000..7dce45b341 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/initialise.md @@ -0,0 +1,53 @@ + + + +# initialise method + + + + + + + + +void initialise +([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) + + + + + + + + +## Implementation + +```dart +void initialise(BuildContext context) { + currentUser = userConfig.currentUser; + pendingRequestOrg = currentUser.membershipRequests!; + // greetings + greeting = [ + { + 'text': "Please wait", + 'textStyle': Theme.of(context).textTheme.headlineSmall + }, + { + '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/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md new file mode 100644 index 0000000000..428ddfc297 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/joinOrg.md @@ -0,0 +1,36 @@ + + + +# joinOrg method + + + + + + + + +void joinOrg +() + + + + + + + + +## Implementation + +```dart +void joinOrg() { + navigationService.pushScreen(Routes.joinOrg, arguments: '-1'); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md new file mode 100644 index 0000000000..278a53c3ed --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/logout.md @@ -0,0 +1,45 @@ + + + +# logout method + + + + + + + + +void logout +() + + + + + +

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

+ + + +## Implementation + +```dart +void logout() { + final user = Hive.box('currentUser'); + final url = Hive.box('url'); + user.clear(); + url.clear(); + navigationService.removeAllAndPush( + Routes.languageSelectionRoute, + Routes.splashScreen, + arguments: '0', + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md new file mode 100644 index 0000000000..9ca3922f29 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel/pendingRequestOrg.md @@ -0,0 +1,32 @@ + + + +# pendingRequestOrg property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> pendingRequestOrg + +_read / write_ + + + + + + +## Implementation + +```dart +late List pendingRequestOrg; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/view_model_pre_auth_view_models_waiting_view_model-library.md b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/view_model_pre_auth_view_models_waiting_view_model-library.md new file mode 100644 index 0000000000..9a3ae1c442 --- /dev/null +++ b/talawa-mobile-docs/view_model_pre_auth_view_models_waiting_view_model/view_model_pre_auth_view_models_waiting_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# waiting_view_model library + + + + + + + + + + + +## Classes + +##### [WaitingViewModel](../view_model_pre_auth_view_models_waiting_view_model/WaitingViewModel-class.md) + + + +WaitingViewModel class helps to interact with model to serve data +and react to user's input for Waiting section. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md b/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md new file mode 100644 index 0000000000..237c0f90f8 --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/AppTheme-class.md @@ -0,0 +1,220 @@ + + + +# AppTheme class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- AppTheme + + + + + + + + +## Constructors + +[AppTheme](../view_model_theme_view_model/AppTheme/AppTheme.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [isdarkTheme](../view_model_theme_view_model/AppTheme/isdarkTheme.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-only_ + + + +##### [key](../view_model_theme_view_model/AppTheme/key.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [initialize](../view_model_theme_view_model/AppTheme/initialize.md)() void + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [switchTheme](../view_model_theme_view_model/AppTheme/switchTheme.md)({required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isOn}) void + + + +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/AppTheme/AppTheme.md b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/AppTheme.md new file mode 100644 index 0000000000..4e8b04727b --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/AppTheme.md @@ -0,0 +1,24 @@ + + + +# AppTheme constructor + + + + + + + +AppTheme() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md new file mode 100644 index 0000000000..da8232bbd3 --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/initialize.md @@ -0,0 +1,37 @@ + + + +# initialize method + + + + + + + + +void initialize +() + + + + + + + + +## Implementation + +```dart +void initialize() { + _isDarkMode = true; + _loadFromPrefs(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md new file mode 100644 index 0000000000..4c2bac3ff5 --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/isdarkTheme.md @@ -0,0 +1,35 @@ + + + +# isdarkTheme property + + + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isdarkTheme + + + + + + + + +## Implementation + +```dart +bool get isdarkTheme => _isDarkMode; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md new file mode 100644 index 0000000000..ca43167820 --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/key.md @@ -0,0 +1,32 @@ + + + +# key property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) key + +_final_ + + + + + + +## Implementation + +```dart +final String key = "DynamicTheme"; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md new file mode 100644 index 0000000000..25663ba89b --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/AppTheme/switchTheme.md @@ -0,0 +1,43 @@ + + + +# switchTheme method + + + + + + + + +void switchTheme +({required [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isOn}) + + + + + +

This function switches the app theme.

+
    +
  • Dart -> Light
  • +
  • Light -> Dark
  • +
+ + + +## Implementation + +```dart +void switchTheme({required bool isOn}) { + _isDarkMode = isOn; + _saveToPrefs(); + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_theme_view_model/view_model_theme_view_model-library.md b/talawa-mobile-docs/view_model_theme_view_model/view_model_theme_view_model-library.md new file mode 100644 index 0000000000..46949516ec --- /dev/null +++ b/talawa-mobile-docs/view_model_theme_view_model/view_model_theme_view_model-library.md @@ -0,0 +1,38 @@ + + + + +# theme_view_model library + + + + + + + + + + + +## Classes + +##### [AppTheme](../view_model_theme_view_model/AppTheme-class.md) + + + +AppTheme class is a type of View Model to serve data from modal to views in the context of App Themes. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md new file mode 100644 index 0000000000..4e83dc4097 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md @@ -0,0 +1,242 @@ + + + +# CommentsViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- CommentsViewModel + + + + + + + + +## Constructors + +[CommentsViewModel](../view_model_widgets_view_models_comments_view_model/CommentsViewModel/CommentsViewModel.md) () + + + + +## 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)> + + + + +_read-only_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + + + + + + +##### [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_ + + + +##### [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. + + + + +##### [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_ + + + +##### [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. + + + + +##### [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) + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/CommentsViewModel.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/CommentsViewModel.md new file mode 100644 index 0000000000..6be109507a --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/CommentsViewModel.md @@ -0,0 +1,24 @@ + + + +# CommentsViewModel constructor + + + + + + + +CommentsViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md new file mode 100644 index 0000000000..093423e4e2 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/addCommentLocally.md @@ -0,0 +1,44 @@ + + + +# addCommentLocally method + + + + + + + + +void addCommentLocally +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) msg) + + + + + + + + +## Implementation + +```dart +void addCommentLocally(String msg) { + _postService.addCommentLocally(_postID); + final creator = _userConfig.currentUser; + final Comment localComment = Comment( + text: msg, + createdAt: DateTime.now().toString(), + creator: creator, + ); + _commentlist.insert(0, localComment); + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md new file mode 100644 index 0000000000..520c4d7315 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/commentList.md @@ -0,0 +1,35 @@ + + + +# commentList property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comment](../../models_comment_comment_model/Comment-class.md)> commentList + + + + + + + + +## Implementation + +```dart +List get commentList => _commentlist; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md new file mode 100644 index 0000000000..28f2ea742c --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/createComment.md @@ -0,0 +1,44 @@ + + + +# createComment method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +Future createComment(String msg) async { + print("comment viewModel called"); + await _commentService.createComments(_postID, msg); + addCommentLocally(msg); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md new file mode 100644 index 0000000000..8969fdda41 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/getComments.md @@ -0,0 +1,45 @@ + + + +# getComments method + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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)); + }); + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md new file mode 100644 index 0000000000..7515645c57 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/initialise.md @@ -0,0 +1,42 @@ + + + +# initialise method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html) initialise +([String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID) + + + + + + + + +## Implementation + +```dart +Future initialise(String postID) async { + _commentlist = []; + _postID = postID; + _commentService = locator(); + _userConfig = locator(); + _postService = locator(); + notifyListeners(); + await getComments(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md new file mode 100644 index 0000000000..fe08747d2e --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/CommentsViewModel/postId.md @@ -0,0 +1,35 @@ + + + +# postId property + + + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) postId + + + + + + + + +## Implementation + +```dart +String get postId => _postID; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/view_model_widgets_view_models_comments_view_model-library.md b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/view_model_widgets_view_models_comments_view_model-library.md new file mode 100644 index 0000000000..05ca1b6599 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_comments_view_model/view_model_widgets_view_models_comments_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# comments_view_model library + + + + + + + + + + + +## Classes + +##### [CommentsViewModel](../view_model_widgets_view_models_comments_view_model/CommentsViewModel-class.md) + + + +CommentsViewModel class helps to serve the data from model +and to react to user's input for Comment Widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md new file mode 100644 index 0000000000..5379596e0a --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md @@ -0,0 +1,269 @@ + + + +# CustomDrawerViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- CustomDrawerViewModel + + + + + + + + +## Constructors + +[CustomDrawerViewModel](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/CustomDrawerViewModel.md) () + + + + +## Properties + +##### [controller](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md) → [ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [selectedOrg](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/selectedOrg.md) → [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? + + + + +_read-only_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [dispose](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md)() 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). +_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 + + + + + + + + +##### [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. + + + + +##### [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_ + + + +##### [notifyListeners](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md)() void + + + +Call all the registered listeners. +_override_ + + + +##### [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_ + + + +##### [setSelectedOrganizationName](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/setSelectedOrganizationName.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) updatedOrganization) void + + + +This function switches the current organization to new organization. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [switchOrg](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchOrg.md)([OrgInfo](../models_organization_org_info/OrgInfo-class.md) switchToOrg) void + + + +This function switch the current organization to another organization, +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) + + + +A string representation of this object. +_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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/CustomDrawerViewModel.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/CustomDrawerViewModel.md new file mode 100644 index 0000000000..c3636dcc0e --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/CustomDrawerViewModel.md @@ -0,0 +1,24 @@ + + + +# CustomDrawerViewModel constructor + + + + + + + +CustomDrawerViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md new file mode 100644 index 0000000000..00b8f4d3b3 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/controller.md @@ -0,0 +1,32 @@ + + + +# controller property + + + + + + + +[ScrollController](https://api.flutter.dev/flutter/widgets/ScrollController-class.html) controller + +_final_ + + + + + + +## Implementation + +```dart +final ScrollController controller = ScrollController(); +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md new file mode 100644 index 0000000000..b73e68485b --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/dispose.md @@ -0,0 +1,47 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_override_ + + + +

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 +it is called. Consumers of this class must decide on whether to notify +listeners or not immediately before disposal.

+ + + +## Implementation + +```dart +@override +void dispose() { + _disposed = true; + _currentOrganizationStreamSubscription?.cancel(); + super.dispose(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md new file mode 100644 index 0000000000..8d3d536fe1 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/initialize.md @@ -0,0 +1,44 @@ + + + +# initialize method + + + + + + + + +void initialize +([MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel, [BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) + + + + + + + + +## Implementation + +```dart +void initialize(MainScreenViewModel homeModel, BuildContext context) { + _currentOrganizationStreamSubscription = + userConfig.currentOrgInfoStream.listen( + (updatedOrganization) { + setSelectedOrganizationName(updatedOrganization); + }, + ); + _currentUser = userConfig.currentUser; + _selectedOrg = userConfig.currentOrg; + _switchAbleOrg = _currentUser.joinedOrganizations!; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md new file mode 100644 index 0000000000..ccf6f13c79 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/isPresentinSwitchableOrg.md @@ -0,0 +1,47 @@ + + + +# isPresentinSwitchableOrg method + + + + + + + + +[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.
  • +
+ + + +## Implementation + +```dart +bool isPresentinSwitchableOrg(OrgInfo switchToOrg) { + var isPresent = false; + for (final OrgInfo orgs in switchAbleOrg) { + if (orgs.id == switchToOrg.id) { + isPresent = true; + } + } + return isPresent; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md new file mode 100644 index 0000000000..1256555b55 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/notifyListeners.md @@ -0,0 +1,51 @@ + + + +# notifyListeners method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void notifyListeners +() + +_override_ + + + +

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. +in response to a notification) that has been registered multiple times. +See the discussion at removeListener.

+ + + +## Implementation + +```dart +@override +void notifyListeners() { + if (!_disposed) { + super.notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/selectedOrg.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/selectedOrg.md new file mode 100644 index 0000000000..55ad05093b --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/selectedOrg.md @@ -0,0 +1,35 @@ + + + +# selectedOrg property + + + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? selectedOrg + + + + + + + + +## Implementation + +```dart +OrgInfo? get selectedOrg => _selectedOrg; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/setSelectedOrganizationName.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/setSelectedOrganizationName.md new file mode 100644 index 0000000000..ebc514a5e3 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/setSelectedOrganizationName.md @@ -0,0 +1,47 @@ + + + +# setSelectedOrganizationName method + + + + + + + + +void setSelectedOrganizationName +([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) updatedOrganization) + + + + + +

This function switches the current organization to new organization.

+

params:

+
    +
  • updatedOrganization : OrgInfo type, new organization.
  • +
+ + + +## Implementation + +```dart +void setSelectedOrganizationName(OrgInfo updatedOrganization) { + // if current and updated organization are not same. + if (_selectedOrg != updatedOrganization) { + _selectedOrg = updatedOrganization; + // update in `UserConfig` variable. + userConfig.currentOrgInfoController.add(_selectedOrg!); + notifyListeners(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchAbleOrg.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchAbleOrg.md new file mode 100644 index 0000000000..604cd61819 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchAbleOrg.md @@ -0,0 +1,54 @@ + + + +# switchAbleOrg property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> switchAbleOrg + + + + + + + + +## Implementation + +```dart +List get switchAbleOrg => _switchAbleOrg; +``` + + + + + +switchAbleOrg= +([List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)> switchableOrg) + + + + + + + +## Implementation + +```dart +set switchAbleOrg(List switchableOrg) => + _switchAbleOrg = switchableOrg; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchOrg.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchOrg.md new file mode 100644 index 0000000000..2cccdb4b7d --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/switchOrg.md @@ -0,0 +1,53 @@ + + + +# switchOrg method + + + + + + + + +void switchOrg +([OrgInfo](../../models_organization_org_info/OrgInfo-class.md) switchToOrg) + + + + + +

This function switch the current organization to another organization, +if the organization(want switch to) is present.

+ + + +## Implementation + +```dart +void switchOrg(OrgInfo switchToOrg) { + // if `selectedOrg` is equal to `switchOrg` and `switchToOrg` present or not. + if (selectedOrg == switchToOrg && isPresentinSwitchableOrg(switchToOrg)) { + // _navigationService.pop(); + navigationService.showTalawaErrorSnackBar( + '${switchToOrg.name} already selected', + MessageType.warning, + ); + } else { + userConfig.saveCurrentOrgInHive(switchToOrg); + setSelectedOrganizationName(switchToOrg); + navigationService.showTalawaErrorSnackBar( + 'Switched to ${switchToOrg.name}', + MessageType.info, + ); + } + navigationService.pop(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/targets.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/targets.md new file mode 100644 index 0000000000..730ed6ecb9 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/targets.md @@ -0,0 +1,32 @@ + + + +# targets property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +final List targets = []; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md new file mode 100644 index 0000000000..8267cc6f14 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel/tutorialCoachMark.md @@ -0,0 +1,32 @@ + + + +# tutorialCoachMark property + + + + + + + +[TutorialCoachMark](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/TutorialCoachMark-class.html) tutorialCoachMark + +_read / write_ + + + + + + +## Implementation + +```dart +late TutorialCoachMark tutorialCoachMark; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/view_model_widgets_view_models_custom_drawer_view_model-library.md b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/view_model_widgets_view_models_custom_drawer_view_model-library.md new file mode 100644 index 0000000000..f9c8909775 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_custom_drawer_view_model/view_model_widgets_view_models_custom_drawer_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# custom_drawer_view_model library + + + + + + + + + + + +## Classes + +##### [CustomDrawerViewModel](../view_model_widgets_view_models_custom_drawer_view_model/CustomDrawerViewModel-class.md) + + + +CustomDrawerViewModel class helps to serve the data and +to react to user's input for Custom Dialog Widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_event_card_view_model/view_model_widgets_view_models_event_card_view_model-library.md b/talawa-mobile-docs/view_model_widgets_view_models_event_card_view_model/view_model_widgets_view_models_event_card_view_model-library.md new file mode 100644 index 0000000000..40e6bafb6c --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_event_card_view_model/view_model_widgets_view_models_event_card_view_model-library.md @@ -0,0 +1,29 @@ + + + + +# event_card_view_model library + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md new file mode 100644 index 0000000000..f314993621 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md @@ -0,0 +1,260 @@ + + + +# LikeButtonViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- LikeButtonViewModel + + + + + + + + +## Constructors + +[LikeButtonViewModel](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/LikeButtonViewModel.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [checkAndSetTheIsLiked](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md)() void + + + + + + + + +##### [dispose](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md)() 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). +_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 + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [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. + + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [toggleIsLiked](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md)() void + + + +This function add like to the post if not liked and +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) + + + +A string representation of this object. +_inherited_ + + + +##### [updatePost](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md)([Post](../models_post_post_model/Post-class.md) post) void + + + +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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/LikeButtonViewModel.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/LikeButtonViewModel.md new file mode 100644 index 0000000000..c6399f1d3a --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/LikeButtonViewModel.md @@ -0,0 +1,24 @@ + + + +# LikeButtonViewModel constructor + + + + + + + +LikeButtonViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md new file mode 100644 index 0000000000..067e2a13ce --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/checkAndSetTheIsLiked.md @@ -0,0 +1,41 @@ + + + +# checkAndSetTheIsLiked method + + + + + + + + +void checkAndSetTheIsLiked +() + + + + + + + + +## Implementation + +```dart +void checkAndSetTheIsLiked() { + setIsLiked(val: false); + for (var i = 0; i < _likedBy.length; i++) { + if (_likedBy[i].sId == _user.id) { + setIsLiked(); + } + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md new file mode 100644 index 0000000000..f93ec9beb6 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/dispose.md @@ -0,0 +1,46 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_override_ + + + +

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 +it is called. Consumers of this class must decide on whether to notify +listeners or not immediately before disposal.

+ + + +## Implementation + +```dart +@override +// ignore: must_call_super +void dispose() { + _updatePostSubscription.cancel(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md new file mode 100644 index 0000000000..24b3ef3a85 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/initialize.md @@ -0,0 +1,42 @@ + + + +# initialize method + + + + + + + + +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) + + + + + + + + +## Implementation + +```dart +void initialize(List likedBy, String postID) { + _postID = postID; + _user = _userConfig.currentUser; + _likedBy = likedBy; + notifyListeners(); + checkAndSetTheIsLiked(); + _updatePostSubscription = + _postService.updatedPostStream.listen((post) => updatePost(post)); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md new file mode 100644 index 0000000000..e1e07b47db --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/isLiked.md @@ -0,0 +1,35 @@ + + + +# isLiked property + + + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isLiked + + + + + + + + +## Implementation + +```dart +bool get isLiked => _isLiked; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md new file mode 100644 index 0000000000..d35d176b50 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likedBy.md @@ -0,0 +1,35 @@ + + + +# likedBy property + + + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)> likedBy + + + + + + + + +## Implementation + +```dart +List get likedBy => _likedBy; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md new file mode 100644 index 0000000000..8766c21d52 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/likesCount.md @@ -0,0 +1,35 @@ + + + +# likesCount property + + + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) likesCount + + + + + + + + +## Implementation + +```dart +int get likesCount => _likedBy.length; +``` + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md new file mode 100644 index 0000000000..0f471fd169 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/setIsLiked.md @@ -0,0 +1,38 @@ + + + +# setIsLiked method + + + + + + + + +void setIsLiked +({[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) val = true}) + + + + + +

This function set _isLike to true.

+ + + +## Implementation + +```dart +void setIsLiked({bool val = true}) { + _isLiked = val; + notifyListeners(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md new file mode 100644 index 0000000000..02c2ab66ec --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/toggleIsLiked.md @@ -0,0 +1,42 @@ + + + +# toggleIsLiked method + + + + + + + + +void toggleIsLiked +() + + + + + +

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) { + _postService.addLike(_postID); + } else { + _postService.removeLike(_postID); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md new file mode 100644 index 0000000000..4076fffea5 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel/updatePost.md @@ -0,0 +1,42 @@ + + + +# updatePost method + + + + + + + + +void updatePost +([Post](../../models_post_post_model/Post-class.md) post) + + + + + +

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) { + _likedBy = post.likedBy!; + checkAndSetTheIsLiked(); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/view_model_widgets_view_models_like_button_view_model-library.md b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/view_model_widgets_view_models_like_button_view_model-library.md new file mode 100644 index 0000000000..d178be9209 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_like_button_view_model/view_model_widgets_view_models_like_button_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# like_button_view_model library + + + + + + + + + + + +## Classes + +##### [LikeButtonViewModel](../view_model_widgets_view_models_like_button_view_model/LikeButtonViewModel-class.md) + + + +LikeButtonViewModel class helps to serve the data and +to react to user's input for Like Button Widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md new file mode 100644 index 0000000000..1fb945caab --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md @@ -0,0 +1,208 @@ + + + +# ProgressDialogViewModel class + + + + + + + + + +

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) +- [BaseModel](../view_model_base_view_model/BaseModel-class.md) +- ProgressDialogViewModel + + + + + + + + +## Constructors + +[ProgressDialogViewModel](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/ProgressDialogViewModel.md) () + + + + +## 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) + + + + +_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) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [isBusy](../view_model_base_view_model/BaseModel/isBusy.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read-onlyinherited_ + + + +##### [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_ + + + +##### [state](../view_model_base_view_model/BaseModel/state.md) → [ViewState](../enums_enums/ViewState.md) + + + + +_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 + + + +Register a closure to be called when the object changes. +_inherited_ + + + +##### [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_ + + + +##### [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> + + + + + + + + +##### [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_ + + + +##### [notifyListeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html)() void + + + +Call all the registered listeners. +_inherited_ + + + +##### [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_ + + + +##### [setState](../view_model_base_view_model/BaseModel/setState.md)([ViewState](../enums_enums/ViewState.md) viewState) void + + + + +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/ProgressDialogViewModel.md b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/ProgressDialogViewModel.md new file mode 100644 index 0000000000..f59d835a47 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/ProgressDialogViewModel.md @@ -0,0 +1,24 @@ + + + +# ProgressDialogViewModel constructor + + + + + + + +ProgressDialogViewModel() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md new file mode 100644 index 0000000000..db77d704cc --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityPresent.md @@ -0,0 +1,32 @@ + + + +# connectivityPresent property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) connectivityPresent + +_read / write_ + + + + + + +## Implementation + +```dart +bool connectivityPresent = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md new file mode 100644 index 0000000000..f3c500a127 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/connectivityResult.md @@ -0,0 +1,32 @@ + + + +# connectivityResult property + + + + + + + +[ConnectivityResult](https://pub.dev/documentation/connectivity_plus_platform_interface/1.2.4/connectivity_plus_platform_interface/ConnectivityResult.html) connectivityResult + +_read / write_ + + + + + + +## Implementation + +```dart +late ConnectivityResult connectivityResult; +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md new file mode 100644 index 0000000000..7389c3d929 --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel/initialise.md @@ -0,0 +1,45 @@ + + + +# initialise method + + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<void> initialise +() + + + + + + + + +## Implementation + +```dart +Future initialise() async { + setState(ViewState.busy); + connectivityResult = await connectivity.checkConnectivity(); + if (connectivityResult == ConnectivityResult.none) { + connectivityPresent = false; + Future.delayed(const Duration(seconds: 2)) + .then((value) => navigationService.pop()); + } else { + connectivityPresent = true; + } + setState(ViewState.idle); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/view_model_widgets_view_models_progress_dialog_view_model-library.md b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/view_model_widgets_view_models_progress_dialog_view_model-library.md new file mode 100644 index 0000000000..51f0ddc22d --- /dev/null +++ b/talawa-mobile-docs/view_model_widgets_view_models_progress_dialog_view_model/view_model_widgets_view_models_progress_dialog_view_model-library.md @@ -0,0 +1,39 @@ + + + + +# progress_dialog_view_model library + + + + + + + + + + + +## Classes + +##### [ProgressDialogViewModel](../view_model_widgets_view_models_progress_dialog_view_model/ProgressDialogViewModel-class.md) + + + +ProgressDialogViewModel class helps to serve the data and +to react to user's input for Progress Dialog Widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md new file mode 100644 index 0000000000..f61800c2df --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost-class.md @@ -0,0 +1,198 @@ + + + +# AddPost class + + + + + + + + + +

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) +- AddPost + + + + + + + + +## 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}) + + _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. +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md new file mode 100644 index 0000000000..a98f0d2a1a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/AddPost.md @@ -0,0 +1,29 @@ + + + +# AddPost constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const AddPost({Key? key, this.drawerKey}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md new file mode 100644 index 0000000000..dc744fe0ae --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/build.md @@ -0,0 +1,229 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Scaffold( + resizeToAvoidBottomInset: false, + // header for the widget + appBar: AppBar( + backgroundColor: Theme.of(context).primaryColor, + elevation: 0.9, + centerTitle: true, + // header title + title: Text( + AppLocalizations.of(context)!.strictTranslate('Share News'), + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + leading: IconButton( + //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(), + ), + // button to upload the post. + actions: [ + TextButton( + key: const Key('add_post_text_btn1'), + onPressed: () => model.uploadPost(), + child: Text( + AppLocalizations.of(context)!.strictTranslate("Post"), + style: Theme.of(context).textTheme.headlineSmall!.copyWith( + fontWeight: FontWeight.w600, + color: Theme.of(context).colorScheme.secondary, + ), + ), + ), + ], + ), + body: BaseView( + onModelReady: (m) { + m.initialise(); + model = m; + }, + builder: (context, model, child) => SingleChildScrollView( + child: Column( + children: [ + ListTile( + leading: const CircleAvatar(radius: 25), + title: Text(model.userName), + subtitle: Text( + AppLocalizations.of(context)!.strictTranslate(model.orgName), + ), + ), + // renders icon button to upload post files. + Row( + children: [ + // button to select the photo from gallery. + IconButton( + key: const Key('add_post_icon_button2'), + onPressed: () => model.getImageFromGallery(), + icon: const Icon(Icons.photo), + ), + // button to capture the image. + IconButton( + key: const Key('add_post_icon_button3'), + onPressed: () => model.getImageFromGallery(camera: true), + icon: const Icon(Icons.camera_alt), + ), + // button to select file + IconButton( + key: const Key('add_post_icon_button4'), + onPressed: () {}, + icon: const Icon(Icons.file_upload), + ), + // button to add hastags to the post. + TextButton( + key: const Key('add_post_text_btn2'), + onPressed: () {}, + child: Text( + '# ${AppLocalizations.of(context)!.strictTranslate("Add hashtag")}', + style: Theme.of(context).textTheme.titleLarge, + ), + ), + ], + ), + const Divider(), + Padding( + padding: const EdgeInsets.symmetric(horizontal: 16.0), + child: TextField( + controller: model.titleController, + // input field to write the description of the post. + decoration: InputDecoration( + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + errorBorder: InputBorder.none, + disabledBorder: InputBorder.none, + hintText: AppLocalizations.of(context)!.strictTranslate( + "Enter the title of your post", + ), + label: Text( + AppLocalizations.of(context)!.strictTranslate( + "Title", + ), + ), + ), + ), + ), + const Divider(), + Padding( + padding: const EdgeInsets.symmetric(horizontal: 16.0), + child: TextField( + controller: model.controller, + maxLines: null, + // input field to write the description of the post. + decoration: InputDecoration( + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + errorBorder: InputBorder.none, + disabledBorder: InputBorder.none, + hintText: AppLocalizations.of(context)!.strictTranslate( + "Write here what do you want to share", + ), + ), + ), + ), + // if the image for the post is added then render button to remove it. + model.imageFile != null + // ignore: sized_box_for_whitespace + ? Container( + height: 230, + padding: const EdgeInsets.all(8.0), + child: Stack( + children: [ + Image.file( + model.imageFile!, + fit: BoxFit.cover, + width: MediaQuery.of(context).size.width, + ), + Positioned( + right: 5, + top: 5, + child: IconButton( + onPressed: () => model.removeImage(), + icon: const Icon( + Icons.cancel, + color: Colors.black, + ), + ), + ) + ], + ), + ) + : Container(), + ], + ), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md new file mode 100644 index 0000000000..e50f7f58b2 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_add_post_page/AddPost/drawerKey.md @@ -0,0 +1,33 @@ + + + +# drawerKey property + + + + + + + +[GlobalKey](https://api.flutter.dev/flutter/widgets/GlobalKey-class.html)<[ScaffoldState](https://api.flutter.dev/flutter/material/ScaffoldState-class.html)>? drawerKey + +_final_ + + + +

DrawerKey.

+ + + +## Implementation + +```dart +final GlobalKey? drawerKey; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md b/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md new file mode 100644 index 0000000000..b885e47961 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_add_post_page/model.md @@ -0,0 +1,36 @@ + + + +# model top-level property + + + + + + + + + +[AddPostViewModel](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md) model + +_read / write_ + + + +

Add Post View Model.

+ + + +## Implementation + +```dart +late AddPostViewModel model; +``` + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md b/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md new file mode 100644 index 0000000000..1283c8ee08 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_add_post_page/views_after_auth_screens_add_post_page-library.md @@ -0,0 +1,49 @@ + + + + +# add_post_page library + + + + + + + + + + + +## Classes + +##### [AddPost](../views_after_auth_screens_add_post_page/AddPost-class.md) + + + +AddPost returns a widget to add(upload) the post. + + + + + + +## Properties + +##### [model](../views_after_auth_screens_add_post_page/model.md) ↔ [AddPostViewModel](../view_model_after_auth_view_models_add_post_view_models_add_post_view_model/AddPostViewModel-class.md) + + + +Add Post View Model. +_read / write_ + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md new file mode 100644 index 0000000000..b86bb1fbda --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md @@ -0,0 +1,189 @@ + + + +# AppSettingsPage class + + + + + + + + + +

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) +- AppSettingsPage + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md)() _AppSettingsPageState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md new file mode 100644 index 0000000000..cef89c44bc --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/AppSettingsPage.md @@ -0,0 +1,29 @@ + + + +# AppSettingsPage constructor + + + + + + +const +AppSettingsPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const AppSettingsPage({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md new file mode 100644 index 0000000000..f6f01c5f1d --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_AppSettingsPageState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_AppSettingsPageState createState() => _AppSettingsPageState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/views_after_auth_screens_app_settings_app_settings_page-library.md b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/views_after_auth_screens_app_settings_app_settings_page-library.md new file mode 100644 index 0000000000..b5eed9934f --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_app_settings_app_settings_page/views_after_auth_screens_app_settings_app_settings_page-library.md @@ -0,0 +1,38 @@ + + + + +# app_settings_page library + + + + + + + + + + + +## Classes + +##### [AppSettingsPage](../views_after_auth_screens_app_settings_app_settings_page/AppSettingsPage-class.md) + + + +AppSettingsPage is a widget that has mutable state _AppSettingsPageState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md new file mode 100644 index 0000000000..d85f9dd3e1 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md @@ -0,0 +1,190 @@ + + + +# ChatPage class + + + + + + + + + +

ChatPage returns a stateless widget for current user Chat Page which renders +the list of all the users that the current user has chat with.

+ + + +**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) +- ChatPage + + + + + + + + +## Constructors + +[ChatPage](../views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md new file mode 100644 index 0000000000..c9653c01c9 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/ChatPage.md @@ -0,0 +1,29 @@ + + + +# ChatPage constructor + + + + + + +const +ChatPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const ChatPage({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md new file mode 100644 index 0000000000..11b31fb2a5 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/ChatPage/build.md @@ -0,0 +1,114 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return DefaultTabController( + length: 2, + child: Scaffold( + appBar: AppBar( + backgroundColor: Theme.of(context).primaryColor, + elevation: 0.0, + centerTitle: true, + title: Text( + "Chats", + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + bottom: const TabBar( + tabs: [ + Tab( + text: "Direct", + ), + Tab( + text: "Events", + ), + ], + ), + ), + // returns a tabs on the top for current user to switch between DirectChats and EventChats. + body: const TabBarView( + children: [ + DirectChats(), + EventChats(), + ], + ), + floatingActionButton: FloatingActionButton( + // onPressed to FloatingActionButton renders SelectContact Widget to chat with other users in the connection. + onPressed: () { + Navigator.push( + context, + MaterialPageRoute(builder: (context) => const SelectContact()), + ); + }, + child: const Icon(Icons.add), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/views_after_auth_screens_chat_chat_list_screen-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/views_after_auth_screens_chat_chat_list_screen-library.md new file mode 100644 index 0000000000..fe58d69526 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_list_screen/views_after_auth_screens_chat_chat_list_screen-library.md @@ -0,0 +1,39 @@ + + + + +# chat_list_screen library + + + + + + + + + + + +## Classes + +##### [ChatPage](../views_after_auth_screens_chat_chat_list_screen/ChatPage-class.md) + + + +ChatPage returns a stateless widget for current user Chat Page which renders +the list of all the users that the current user has chat with. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md new file mode 100644 index 0000000000..131bed1967 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md @@ -0,0 +1,207 @@ + + + +# ChatMessageScreen class + + + + + + + + + +

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) +- ChatMessageScreen + + + + + + + + +## 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}) + + _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) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [model](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md) → [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md new file mode 100644 index 0000000000..f6d0c8a5e6 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/ChatMessageScreen.md @@ -0,0 +1,30 @@ + + + +# ChatMessageScreen constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const ChatMessageScreen({Key? key, required this.chatId, required this.model}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md new file mode 100644 index 0000000000..0ba68ed581 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/build.md @@ -0,0 +1,122 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + model.getChatMessages(chatId); + model.chatName(chatId); + return Scaffold( + appBar: AppBar( + automaticallyImplyLeading: false, + title: Row( + children: [ + IconButton( + icon: const Icon(Icons.arrow_back), + onPressed: () => Navigator.pop(context), + ), + SizedBox(width: SizeConfig.safeBlockHorizontal! * 3), + CircleAvatar( + backgroundColor: Colors.white, + radius: SizeConfig.blockSizeVertical! * 2.3, + ), + SizedBox(width: SizeConfig.safeBlockHorizontal! * 3), + Text('${model.name}'), + ], + ), + ), + body: BaseView( + onModelReady: (model) => model.getChatMessages(chatId), + builder: (context, model, child) => + (Provider.of(context).chatState == + ChatState.complete) + ? Column( + children: [ + Expanded( + child: Padding( + padding: EdgeInsets.symmetric( + horizontal: SizeConfig.safeBlockHorizontal! * 3, + ), + child: ListView.builder( + itemCount: model.chatMessagesByUser[chatId]!.length, + itemBuilder: (context, index) { + return Message( + message: + model.chatMessagesByUser[chatId]![index], + ); + }, + ), + ), + ), + ChatInputField(chatId: chatId, model: model), + ], + ) + : const Center( + child: CircularProgressIndicator(), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md new file mode 100644 index 0000000000..2dc5c3bec5 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/chatId.md @@ -0,0 +1,32 @@ + + + +# chatId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId + +_final_ + + + + + + +## Implementation + +```dart +final String chatId; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md new file mode 100644 index 0000000000..45becc144a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen/model.md @@ -0,0 +1,32 @@ + + + +# model property + + + + + + + +[DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model + +_final_ + + + + + + +## Implementation + +```dart +final DirectChatViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/views_after_auth_screens_chat_chat_message_screen-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/views_after_auth_screens_chat_chat_message_screen-library.md new file mode 100644 index 0000000000..7ee3f70218 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_chat_message_screen/views_after_auth_screens_chat_chat_message_screen-library.md @@ -0,0 +1,38 @@ + + + + +# chat_message_screen library + + + + + + + + + + + +## Classes + +##### [ChatMessageScreen](../views_after_auth_screens_chat_chat_message_screen/ChatMessageScreen-class.md) + + + +ChatMessageScreen returns a StatelessWidget for showing the chat message screen. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md new file mode 100644 index 0000000000..aa7aa3b890 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile-class.md @@ -0,0 +1,207 @@ + + + +# ChatTile class + + + + + + + + + +

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) +- ChatTile + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [chat](../views_after_auth_screens_chat_direct_chats/ChatTile/chat.md) → [ChatListTileDataModel](../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [model](../views_after_auth_screens_chat_direct_chats/ChatTile/model.md) → [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md new file mode 100644 index 0000000000..d57031896b --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/ChatTile.md @@ -0,0 +1,30 @@ + + + +# ChatTile constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const ChatTile({Key? key, required this.chat, required this.model}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md new file mode 100644 index 0000000000..b568e64b03 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/build.md @@ -0,0 +1,78 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return ListTile( + onTap: () => navigationService + .pushScreen(Routes.chatMessageScreen, arguments: [chat.id, model]), + leading: const CircleAvatar( + radius: 20, + ), + title: Text(chat.users![0].firstName!), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md new file mode 100644 index 0000000000..f685bdc767 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/chat.md @@ -0,0 +1,32 @@ + + + +# chat property + + + + + + + +[ChatListTileDataModel](../../models_chats_chat_list_tile_data_model/ChatListTileDataModel-class.md) chat + +_final_ + + + + + + +## Implementation + +```dart +final ChatListTileDataModel chat; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md new file mode 100644 index 0000000000..45becc144a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/ChatTile/model.md @@ -0,0 +1,32 @@ + + + +# model property + + + + + + + +[DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model + +_final_ + + + + + + +## Implementation + +```dart +final DirectChatViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md new file mode 100644 index 0000000000..2db88e0c78 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats-class.md @@ -0,0 +1,190 @@ + + + +# DirectChats class + + + + + + + + + +

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) +- DirectChats + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md new file mode 100644 index 0000000000..bacac35bad --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/DirectChats.md @@ -0,0 +1,29 @@ + + + +# DirectChats constructor + + + + + + +const +DirectChats({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const DirectChats({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md new file mode 100644 index 0000000000..13c976ecbd --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/DirectChats/build.md @@ -0,0 +1,85 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.initialise(), + builder: (context, model, child) { + return ListView.builder( + // key: model.listKey, + itemCount: model.chats.length, + itemBuilder: (context, index) { + return ChatTile( + chat: model.chats[index], + model: model, + ); + }, + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md new file mode 100644 index 0000000000..f52c976e02 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_direct_chats/views_after_auth_screens_chat_direct_chats-library.md @@ -0,0 +1,46 @@ + + + + +# direct_chats library + + + + + + + + + + + +## Classes + +##### [ChatTile](../views_after_auth_screens_chat_direct_chats/ChatTile-class.md) + + + +ChatTile return a widget for a tile in the list of Direct Chats in the Chat List Screen. + + +##### [DirectChats](../views_after_auth_screens_chat_direct_chats/DirectChats-class.md) + + + +DirectChats return a statelessWidget for rendering all the directs +chats of the current user in the Chat List Screen + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md new file mode 100644 index 0000000000..afab3cf588 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats-class.md @@ -0,0 +1,190 @@ + + + +# EventChats class + + + + + + + + + +

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) +- EventChats + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md new file mode 100644 index 0000000000..5186b08227 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/EventChats.md @@ -0,0 +1,29 @@ + + + +# EventChats constructor + + + + + + +const +EventChats({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const EventChats({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md new file mode 100644 index 0000000000..0552bb07a5 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/EventChats/build.md @@ -0,0 +1,73 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Container( + child: null, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/views_after_auth_screens_chat_event_chats-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/views_after_auth_screens_chat_event_chats-library.md new file mode 100644 index 0000000000..692360af1e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_event_chats/views_after_auth_screens_chat_event_chats-library.md @@ -0,0 +1,39 @@ + + + + +# event_chats library + + + + + + + + + + + +## Classes + +##### [EventChats](../views_after_auth_screens_chat_event_chats/EventChats-class.md) + + + +EventChats return a statelessWidget for rendering all the events +chats of the current user in the Chat List Screen + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md new file mode 100644 index 0000000000..790f504b5a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact-class.md @@ -0,0 +1,189 @@ + + + +# SelectContact class + + + + + + + + + +

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) +- SelectContact + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_chat_select_contact/SelectContact/createState.md)() _SelectContactState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md new file mode 100644 index 0000000000..d896d61fda --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/SelectContact.md @@ -0,0 +1,29 @@ + + + +# SelectContact constructor + + + + + + +const +SelectContact({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const SelectContact({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md new file mode 100644 index 0000000000..34529da24d --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/SelectContact/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_SelectContactState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_SelectContactState createState() => _SelectContactState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/views_after_auth_screens_chat_select_contact-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/views_after_auth_screens_chat_select_contact-library.md new file mode 100644 index 0000000000..f924dee20e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_select_contact/views_after_auth_screens_chat_select_contact-library.md @@ -0,0 +1,38 @@ + + + + +# select_contact library + + + + + + + + + + + +## Classes + +##### [SelectContact](../views_after_auth_screens_chat_select_contact/SelectContact-class.md) + + + +SelectContact returns a widget that has mutable state _SelectContactState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md new file mode 100644 index 0000000000..8eb6460855 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md @@ -0,0 +1,207 @@ + + + +# ChatInputField class + + + + + + + + + +

ChatInputField returns a widget that has mutable state _ChatInputFieldState.

+ + + +**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) +- ChatInputField + + + + + + + + +## Constructors + +[ChatInputField](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md) ({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}) + + _const_ + + +## Properties + +##### [chatId](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +ChatId. +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [model](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/model.md) → [DirectChatViewModel](../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) + + + +DirectChatViewModel instance. +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md new file mode 100644 index 0000000000..9521860d9e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/ChatInputField.md @@ -0,0 +1,33 @@ + + + +# ChatInputField constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const ChatInputField({ + required this.chatId, + required this.model, + Key? key, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md new file mode 100644 index 0000000000..e2b3e1207c --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/chatId.md @@ -0,0 +1,33 @@ + + + +# chatId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) chatId + +_final_ + + + +

ChatId.

+ + + +## Implementation + +```dart +final String chatId; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md new file mode 100644 index 0000000000..1d7afc59b1 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[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 +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +State createState() => _ChatInputFieldState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/model.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/model.md new file mode 100644 index 0000000000..3abb558cfe --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField/model.md @@ -0,0 +1,33 @@ + + + +# model property + + + + + + + +[DirectChatViewModel](../../view_model_after_auth_view_models_chat_view_models_direct_chat_view_model/DirectChatViewModel-class.md) model + +_final_ + + + +

DirectChatViewModel instance.

+ + + +## Implementation + +```dart +final DirectChatViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/views_after_auth_screens_chat_widgets_chat_input_field-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/views_after_auth_screens_chat_widgets_chat_input_field-library.md new file mode 100644 index 0000000000..bb61c05cce --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_input_field/views_after_auth_screens_chat_widgets_chat_input_field-library.md @@ -0,0 +1,38 @@ + + + + +# chat_input_field library + + + + + + + + + + + +## Classes + +##### [ChatInputField](../views_after_auth_screens_chat_widgets_chat_input_field/ChatInputField-class.md) + + + +ChatInputField returns a widget that has mutable state _ChatInputFieldState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md new file mode 100644 index 0000000000..7bb1eb0765 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md @@ -0,0 +1,189 @@ + + + +# Message class + + + + + + + + + +

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) +- Message + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md new file mode 100644 index 0000000000..6f392e7481 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/Message.md @@ -0,0 +1,29 @@ + + + +# Message constructor + + + + + + +const +Message({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [ChatMessage](../../models_chats_chat_message/ChatMessage-class.md) message}) + + + + + +## Implementation + +```dart +const Message({Key? key, required this.message}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md new file mode 100644 index 0000000000..824759c161 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/Message/build.md @@ -0,0 +1,117 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + // styling + return Padding( + padding: EdgeInsets.only(top: SizeConfig.safeBlockVertical! * 2), + child: Row( + mainAxisAlignment: + message.sender!.firstName == userConfig.currentUser.firstName + ? MainAxisAlignment.end + : MainAxisAlignment.start, + children: [ + Container( + padding: EdgeInsets.symmetric( + horizontal: SizeConfig.safeBlockHorizontal! * 2, + vertical: SizeConfig.blockSizeVertical! * 1.2, + ), + decoration: BoxDecoration( + // 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 + : Colors.green, + borderRadius: + message.sender!.firstName == userConfig.currentUser.firstName + ? const BorderRadius.only( + bottomRight: Radius.circular(15), + topLeft: Radius.circular(15), + bottomLeft: Radius.circular(15), + ) + : const BorderRadius.only( + bottomRight: Radius.circular(15), + topRight: Radius.circular(15), + bottomLeft: Radius.circular(15), + ), + ), + child: Text( + message.messageContent!, + // 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 + ? Colors.black + : Theme.of(context).textTheme.bodyLarge!.color, + ), + ), + ), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/views_after_auth_screens_chat_widgets_chat_message_bubble-library.md b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/views_after_auth_screens_chat_widgets_chat_message_bubble-library.md new file mode 100644 index 0000000000..7a6b4a4f58 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_chat_widgets_chat_message_bubble/views_after_auth_screens_chat_widgets_chat_message_bubble-library.md @@ -0,0 +1,38 @@ + + + + +# chat_message_bubble library + + + + + + + + + + + +## Classes + +##### [Message](../views_after_auth_screens_chat_widgets_chat_message_bubble/Message-class.md) + + + +Message returns a widget for chat message in the bubble form. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md new file mode 100644 index 0000000000..6899a021e1 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm-class.md @@ -0,0 +1,199 @@ + + + +# CreateEventForm class + + + + + + + + + +

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) +- CreateEventForm + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [model](../views_after_auth_screens_events_create_event_form/CreateEventForm/model.md) → [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md new file mode 100644 index 0000000000..bc499612ce --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/CreateEventForm.md @@ -0,0 +1,29 @@ + + + +# CreateEventForm constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CreateEventForm({Key? key, required this.model}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md new file mode 100644 index 0000000000..4f52a40ccd --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/build.md @@ -0,0 +1,194 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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. + TextFormField( + key: const Key('create_event_form_tff1'), + textInputAction: TextInputAction.next, + controller: model.eventTitleTextController, + keyboardType: TextInputType.name, + maxLength: 20, + focusNode: model.titleFocus, + validator: (value) => Validator.validateEventForm(value!, 'Title'), + decoration: InputDecoration( + // placeholder of the text field + labelText: 'Add Event Title', + isDense: true, + labelStyle: Theme.of(context).textTheme.titleMedium, + focusedBorder: InputBorder.none, + counterText: "", + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.title, + size: 25, + ), + ), + ), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + // 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.validateEventForm(value!, 'Location'), + decoration: InputDecoration( + hintText: 'Where is the event?', + labelText: 'Add Location', + labelStyle: Theme.of(context).textTheme.titleMedium, + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + suffix: GestureDetector( + key: const Key('gesture_cef_test'), + onTap: () => navigationService.pushScreen( + Routes.mapScreen, + arguments: { + 'model': model, + // initalize the map screen with a marker at this location + 'latitude': 37.42796133580664, + 'longitude': -122.085749655962, + }, + ), + child: Text( + AppLocalizations.of(context)! + .strictTranslate('Choose on map'), + style: Theme.of(context) + .textTheme + .bodySmall! + .copyWith(fontSize: 16), + ), + ), + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.place, + size: 25, + ), + ), + ), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + // 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.validateEventForm(value!, 'Description'), + maxLines: 10, + minLines: 1, + decoration: InputDecoration( + hintText: 'Describe the event', + labelText: 'Add Description', + labelStyle: Theme.of(context).textTheme.titleMedium, + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.view_headline, + size: 25, + ), + ), + ), + ), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md new file mode 100644 index 0000000000..bbf439e818 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/CreateEventForm/model.md @@ -0,0 +1,32 @@ + + + +# model property + + + + + + + +[CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md) model + +_final_ + + + + + + +## Implementation + +```dart +final CreateEventViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/views_after_auth_screens_events_create_event_form-library.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/views_after_auth_screens_events_create_event_form-library.md new file mode 100644 index 0000000000..b2576e3208 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_form/views_after_auth_screens_events_create_event_form-library.md @@ -0,0 +1,39 @@ + + + + +# create_event_form library + + + + + + + + + + + +## Classes + +##### [CreateEventForm](../views_after_auth_screens_events_create_event_form/CreateEventForm-class.md) + + + +CreateEventForm returns a widget of a Form for creating events in the organization. +This widget is used in CreateEventPage widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md new file mode 100644 index 0000000000..eae27c46b7 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage-class.md @@ -0,0 +1,189 @@ + + + +# CreateEventPage class + + + + + + + + + +

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) +- CreateEventPage + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md)() _CreateEventPageState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md new file mode 100644 index 0000000000..3692c4ee96 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/CreateEventPage.md @@ -0,0 +1,29 @@ + + + +# CreateEventPage constructor + + + + + + +const +CreateEventPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const CreateEventPage({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md new file mode 100644 index 0000000000..2b79419a36 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/CreateEventPage/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_CreateEventPageState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_CreateEventPageState createState() => _CreateEventPageState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/views_after_auth_screens_events_create_event_page-library.md b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/views_after_auth_screens_events_create_event_page-library.md new file mode 100644 index 0000000000..19a7195448 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_create_event_page/views_after_auth_screens_events_create_event_page-library.md @@ -0,0 +1,38 @@ + + + + +# create_event_page library + + + + + + + + + + + +## Classes + +##### [CreateEventPage](../views_after_auth_screens_events_create_event_page/CreateEventPage-class.md) + + + +CreateEventPage returns a widget that has mutable state _CreateEventPageState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage-class.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage-class.md new file mode 100644 index 0000000000..612885d7f4 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage-class.md @@ -0,0 +1,198 @@ + + + +# EditEventPage class + + + + + + + + + +

EditEventPage returns a widget that has mutable state _EditEventPageState.

+ + + +**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) +- EditEventPage + + + + + + + + +## Constructors + +[EditEventPage](../views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md) ({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../models_events_event_model/Event-class.md) event}) + + _const_ + + +## Properties + +##### [event](../views_after_auth_screens_events_edit_event_page/EditEventPage/event.md) → [Event](../models_events_event_model/Event-class.md) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md)() _EditEventPageState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md new file mode 100644 index 0000000000..101f34c3d2 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/EditEventPage.md @@ -0,0 +1,29 @@ + + + +# EditEventPage constructor + + + + + + +const +EditEventPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Event](../../models_events_event_model/Event-class.md) event}) + + + + + +## Implementation + +```dart +const EditEventPage({Key? key, required this.event}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md new file mode 100644 index 0000000000..f095ce13c6 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_EditEventPageState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_EditEventPageState createState() => _EditEventPageState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/event.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/event.md new file mode 100644 index 0000000000..9714bc41af --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/EditEventPage/event.md @@ -0,0 +1,32 @@ + + + +# event property + + + + + + + +[Event](../../models_events_event_model/Event-class.md) event + +_final_ + + + + + + +## Implementation + +```dart +final Event event; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/views_after_auth_screens_events_edit_event_page-library.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/views_after_auth_screens_events_edit_event_page-library.md new file mode 100644 index 0000000000..03f6aafa35 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_event_page/views_after_auth_screens_events_edit_event_page-library.md @@ -0,0 +1,38 @@ + + + + +# edit_event_page library + + + + + + + + + + + +## Classes + +##### [EditEventPage](../views_after_auth_screens_events_edit_event_page/EditEventPage-class.md) + + + +EditEventPage returns a widget that has mutable state _EditEventPageState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md new file mode 100644 index 0000000000..4b944f0213 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm-class.md @@ -0,0 +1,199 @@ + + + +# EditEventForm class + + + + + + + + + +

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) +- EditEventForm + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [model](../views_after_auth_screens_events_edit_events_form/EditEventForm/model.md) → [EditEventViewModel](../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md new file mode 100644 index 0000000000..355dbe36f7 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/EditEventForm.md @@ -0,0 +1,29 @@ + + + +# EditEventForm constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const EditEventForm({Key? key, required this.model}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md new file mode 100644 index 0000000000..586d7aeeac --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/build.md @@ -0,0 +1,188 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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. + TextFormField( + textInputAction: TextInputAction.next, + controller: model.eventTitleTextController, + keyboardType: TextInputType.name, + maxLength: 20, + focusNode: model.titleFocus, + validator: (value) => Validator.validateEventForm(value!, 'Title'), + decoration: InputDecoration( + labelText: 'Add Event Title', + isDense: true, + labelStyle: Theme.of(context).textTheme.titleMedium, + focusedBorder: InputBorder.none, + counterText: "", + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.title, + size: 25, + ), + ), + suffixIcon: IconButton( + onPressed: () { + FocusScope.of(context).requestFocus(model.titleFocus); + }, + icon: const Icon(Icons.edit), + ), + ), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + // Text field for the location. + TextFormField( + textInputAction: TextInputAction.next, + keyboardType: TextInputType.streetAddress, + controller: model.eventLocationTextController, + focusNode: model.locationFocus, + validator: (value) => + Validator.validateEventForm(value!, 'Location'), + decoration: InputDecoration( + hintText: 'Where is the event?', + labelText: 'Add Location', + labelStyle: Theme.of(context).textTheme.titleMedium, + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.place, + size: 25, + ), + ), + suffixIcon: IconButton( + onPressed: () { + FocusScope.of(context).requestFocus(model.locationFocus); + }, + icon: const Icon(Icons.edit), + ), + ), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + // Text field for event description. + TextFormField( + keyboardType: TextInputType.multiline, + controller: model.eventDescriptionTextController, + focusNode: model.descriptionFocus, + validator: (value) => + Validator.validateEventForm(value!, 'Description'), + maxLines: 10, + minLines: 1, + decoration: InputDecoration( + hintText: 'Describe the event', + labelText: 'Add Description', + labelStyle: Theme.of(context).textTheme.titleMedium, + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.view_headline, + size: 25, + ), + ), + suffixIcon: IconButton( + onPressed: () { + FocusScope.of(context).requestFocus(model.descriptionFocus); + }, + icon: const Icon(Icons.edit), + ), + ), + ), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md new file mode 100644 index 0000000000..9cf984beb4 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/EditEventForm/model.md @@ -0,0 +1,32 @@ + + + +# model property + + + + + + + +[EditEventViewModel](../../view_model_after_auth_view_models_event_view_models_edit_event_view_model/EditEventViewModel-class.md) model + +_final_ + + + + + + +## Implementation + +```dart +final EditEventViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/views_after_auth_screens_events_edit_events_form-library.md b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/views_after_auth_screens_events_edit_events_form-library.md new file mode 100644 index 0000000000..a2c3833967 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_edit_events_form/views_after_auth_screens_events_edit_events_form-library.md @@ -0,0 +1,39 @@ + + + + +# edit_events_form library + + + + + + + + + + + +## Classes + +##### [EditEventForm](../views_after_auth_screens_events_edit_events_form/EditEventForm-class.md) + + + +EditEventForm returns a widget of a Form for editing an event. +This widget is used in EditEventPage widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md new file mode 100644 index 0000000000..5d56cb4be3 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar-class.md @@ -0,0 +1,198 @@ + + + +# EventCalendar class + + + + + + + + + +

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) +- EventCalendar + + + + + + + + +## 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}) + + _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)> + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md new file mode 100644 index 0000000000..65f8fdce03 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/EventCalendar.md @@ -0,0 +1,29 @@ + + + +# EventCalendar constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const EventCalendar(this.eventList, {Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md new file mode 100644 index 0000000000..f0a5f419f0 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[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 +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +State createState() => _EventCalendarState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/eventList.md b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/eventList.md new file mode 100644 index 0000000000..9fb10e4c0e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/EventCalendar/eventList.md @@ -0,0 +1,32 @@ + + + +# eventList property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventList + +_final_ + + + + + + +## Implementation + +```dart +final List eventList; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/views_after_auth_screens_events_event_calendar-library.md b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/views_after_auth_screens_events_event_calendar-library.md new file mode 100644 index 0000000000..d2022d1c00 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_calendar/views_after_auth_screens_events_event_calendar-library.md @@ -0,0 +1,38 @@ + + + + +# event_calendar library + + + + + + + + + + + +## Classes + +##### [EventCalendar](../views_after_auth_screens_events_event_calendar/EventCalendar-class.md) + + + +EventCalendar returns a widget that has mutable state _EventCalendarState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md new file mode 100644 index 0000000000..17d306b078 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody-class.md @@ -0,0 +1,189 @@ + + + +# EventInfoBody class + + + + + + + + + +

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) +- EventInfoBody + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md new file mode 100644 index 0000000000..f2834782c1 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/EventInfoBody.md @@ -0,0 +1,29 @@ + + + +# EventInfoBody constructor + + + + + + +const +EventInfoBody({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const EventInfoBody({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md new file mode 100644 index 0000000000..5800dc4232 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/EventInfoBody/build.md @@ -0,0 +1,332 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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. + return SliverToBoxAdapter( + child: Padding( + padding: const EdgeInsets.all(10), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Stack( + children: [ + Container( + padding: EdgeInsets.only( + right: SizeConfig.safeBlockHorizontal! * 15, + ), + child: Row( + children: [ + Flexible( + child: Text( + // event title + event.title!, + style: Theme.of(context) + .textTheme + .headlineMedium! + .copyWith(fontSize: 26), + ), + ), + ], + ), + ), + Positioned( + right: SizeConfig.screenWidth! * 0.002, + child: Row( + mainAxisSize: MainAxisSize.min, + children: [ + (model.event.creator!.id == userConfig.currentUser.id) + ? IconButton( + onPressed: () => navigationService.pushScreen( + "/editEventPage", + arguments: model.event, + ), + icon: const Icon(Icons.edit), + ) + : Container(), + const Icon(Icons.chat_bubble_outline), + ], + ), + ), + ], + ), + Text( + // Display event creator full name. + "${AppLocalizations.of(context)!.strictTranslate("Created by")}: ${event.creator!.firstName} ${event.creator!.lastName}", + style: Theme.of(context) + .textTheme + .bodyMedium! + .copyWith(fontWeight: FontWeight.w600), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.011, + ), + Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + const Icon( + Icons.calendar_today, + size: 13, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.027, + ), + Text( + // 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. + event.isPublic! + ? Icon( + Icons.lock_open, + size: 13, + color: Theme.of(context).colorScheme.secondary, + ) + : Icon( + Icons.lock, + size: 13, + color: Theme.of(context).colorScheme.primary, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.027, + ), + // 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'), + style: Theme.of(context).textTheme.bodySmall, + ) + : Text( + AppLocalizations.of(context)! + .strictTranslate('private'), + style: Theme.of(context).textTheme.bodySmall, + ), + ], + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.011, + ), + Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + // display schedule icon with the start and end date of the time. + const Icon( + Icons.schedule, + size: 12, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.025, + ), + Text( + "${event.startTime!} - ${event.endTime!}", + style: Theme.of(context).textTheme.bodySmall, + ), + ], + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.011, + ), + Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + const Icon( + Icons.place, + size: 12, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.027, + ), + Text( + event.location!, + style: Theme.of(context).textTheme.bodySmall, + overflow: TextOverflow.ellipsis, + textAlign: TextAlign.left, + 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 (event.latitude != null && event.longitude != null) + GestureDetector( + onTap: () => navigationService.pushScreen( + Routes.mapScreen, + arguments: { + "latitude": event.latitude, + "longitude": event.longitude, + }, + ), + child: Text( + 'View on map', + style: Theme.of(context).textTheme.bodySmall!.copyWith( + color: Theme.of(context).colorScheme.secondary, + ), + overflow: TextOverflow.ellipsis, + textAlign: TextAlign.left, + maxLines: 3, + ), + ), + ], + ), + const Divider(), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + Text( + AppLocalizations.of(context)!.strictTranslate("Description"), + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith(fontSize: 16), + ), + SizedBox(width: SizeConfig.screenWidth! * 0.013), + Text( + // Display the Description of the event if not null. + event.description!, + style: Theme.of(context).textTheme.bodySmall, + ), + SizedBox(height: SizeConfig.screenHeight! * 0.013), + Text( + AppLocalizations.of(context)!.strictTranslate("Admins"), + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith(fontSize: 16), + ), + Divider( + color: Theme.of(context).colorScheme.onBackground, + thickness: 2, + ), + ListView.builder( + padding: EdgeInsets.zero, + physics: const NeverScrollableScrollPhysics(), + shrinkWrap: true, + itemCount: event.admins!.length, + itemBuilder: (BuildContext context, int index) { + return CustomListTile( + key: Key( + '${AppLocalizations.of(context)!.strictTranslate("Admins")}$index', + ), + index: index, + type: TileType.user, + userInfo: event.admins![index], + onTapUserInfo: () {}, + ); + }, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + Text( + AppLocalizations.of(context)!.strictTranslate("Attendees"), + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith(fontSize: 16), + ), + Divider( + color: Theme.of(context).colorScheme.onBackground, + thickness: 2, + ), + if (model.isBusy) + // 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. + ListView.builder( + padding: EdgeInsets.zero, + shrinkWrap: true, + itemCount: model.registrants.length, + itemBuilder: (BuildContext context, int index) { + return CustomListTile( + key: Key( + '${AppLocalizations.of(context)!.strictTranslate("Attendee")}$index', + ), + index: index, + type: TileType.user, + userInfo: model.registrants[index], + onTapUserInfo: () {}, + ); + }, + ) + ], + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/views_after_auth_screens_events_event_info_body-library.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/views_after_auth_screens_events_event_info_body-library.md new file mode 100644 index 0000000000..2035b82bda --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_body/views_after_auth_screens_events_event_info_body-library.md @@ -0,0 +1,38 @@ + + + + +# event_info_body library + + + + + + + + + + + +## Classes + +##### [EventInfoBody](../views_after_auth_screens_events_event_info_body/EventInfoBody-class.md) + + + +EventInfoBody returns a stateless widget which describes the body of a particular event. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md new file mode 100644 index 0000000000..10ec2c8e70 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage-class.md @@ -0,0 +1,198 @@ + + + +# EventInfoPage class + + + + + + + + + +

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) +- EventInfoPage + + + + + + + + +## 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}) + + _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> + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md)() _EventInfoPageState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md new file mode 100644 index 0000000000..f562976668 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/EventInfoPage.md @@ -0,0 +1,29 @@ + + + +# EventInfoPage constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const EventInfoPage({Key? key, required this.args}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md new file mode 100644 index 0000000000..bc15ede0aa --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/args.md @@ -0,0 +1,32 @@ + + + +# args property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +final Map args; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md new file mode 100644 index 0000000000..40792cb7fe --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/EventInfoPage/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_EventInfoPageState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_EventInfoPageState createState() => _EventInfoPageState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/views_after_auth_screens_events_event_info_page-library.md b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/views_after_auth_screens_events_event_info_page-library.md new file mode 100644 index 0000000000..143f14484a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_event_info_page/views_after_auth_screens_events_event_info_page-library.md @@ -0,0 +1,38 @@ + + + + +# event_info_page library + + + + + + + + + + + +## Classes + +##### [EventInfoPage](../views_after_auth_screens_events_event_info_page/EventInfoPage-class.md) + + + +EventInfoPage returns a widget that has mutable state _EventInfoPageState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md new file mode 100644 index 0000000000..fd5c8bca40 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md @@ -0,0 +1,189 @@ + + + +# ExploreEventDialog class + + + + + + + + + +

ExploreEventDialog returns a widget that has mutable state _ExploreEventDialogState.

+ + + +**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) +- ExploreEventDialog + + + + + + + + +## Constructors + +[ExploreEventDialog](../views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md)() _ExploreEventDialogState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md new file mode 100644 index 0000000000..a932b4294c --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/ExploreEventDialog.md @@ -0,0 +1,29 @@ + + + +# ExploreEventDialog constructor + + + + + + +const +ExploreEventDialog({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const ExploreEventDialog({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md new file mode 100644 index 0000000000..f864e77ec6 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_ExploreEventDialogState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_ExploreEventDialogState createState() => _ExploreEventDialogState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/views_after_auth_screens_events_explore_event_dialogue-library.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/views_after_auth_screens_events_explore_event_dialogue-library.md new file mode 100644 index 0000000000..d97223d2ea --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_event_dialogue/views_after_auth_screens_events_explore_event_dialogue-library.md @@ -0,0 +1,38 @@ + + + + +# explore_event_dialogue library + + + + + + + + + + + +## Classes + +##### [ExploreEventDialog](../views_after_auth_screens_events_explore_event_dialogue/ExploreEventDialog-class.md) + + + +ExploreEventDialog returns a widget that has mutable state _ExploreEventDialogState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents-class.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents-class.md new file mode 100644 index 0000000000..31f1fd129c --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents-class.md @@ -0,0 +1,207 @@ + + + +# ExploreEvents class + + + + + + + + + +

Shows the list of events with options to categorize them.

+ + + +**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) +- ExploreEvents + + + + + + + + +## Constructors + +[ExploreEvents](../views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [homeModel](../views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md) → [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md)? + + + +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)? + + + +Controls how one widget replaces another widget in the tree. +_finalinherited_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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. + + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md new file mode 100644 index 0000000000..8329f47a91 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/ExploreEvents.md @@ -0,0 +1,32 @@ + + + +# ExploreEvents constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const ExploreEvents({ + required Key key, + this.homeModel, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md new file mode 100644 index 0000000000..fc8416b517 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/build.md @@ -0,0 +1,291 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.initialise(), + builder: (context, model, child) { + return Scaffold( + appBar: AppBar( + // AppBar returns widget for the header. + backgroundColor: Theme.of(context).primaryColor, + key: const Key("ExploreEventsAppBar"), + elevation: 0.0, + automaticallyImplyLeading: false, + centerTitle: true, + title: Text( + AppLocalizations.of(context)!.strictTranslate('Explore Events'), + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + leading: IconButton( + // returns a button of menu icon to redirect to home. + color: Theme.of(context).iconTheme.color, + icon: const Icon(Icons.menu), + onPressed: () => + MainScreenViewModel.scaffoldKey.currentState!.openDrawer(), + ), + actions: [ + Padding( + 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. + child: model.events.isNotEmpty + ? IconButton( + onPressed: () { + showSearch( + context: context, + delegate: EventSearch( + eventList: model.events, + 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. + body: model.isBusy + ? const Center(child: CircularProgressIndicator()) + : RefreshIndicator( + onRefresh: () async => model.refreshEvents(), + child: Stack( + children: [ + SingleChildScrollView( + physics: const AlwaysScrollableScrollPhysics(), + child: Padding( + padding: EdgeInsets.symmetric( + horizontal: SizeConfig.screenWidth! * 0.010, + ), + child: Column( + children: [ + Row( + mainAxisAlignment: + MainAxisAlignment.spaceBetween, + children: [ + Expanded( + flex: 3, + child: Card( + color: Theme.of(context) + .colorScheme + .onPrimary, + elevation: 2, + child: Container( + padding: const EdgeInsets.symmetric( + horizontal: 20, + ), + //width: SizeConfig.screenWidth! * 0.45, + child: DropdownButtonHideUnderline( + child: dropDownList(model, context), + ), + ), + ), + ), + Expanded( + flex: 2, + child: GestureDetector( + onTap: () { + showDialog( + // on tap open the Explore Event Dialog. + context: context, + builder: (_) { + return const ExploreEventDialog( + key: Key('ExploreEvents'), + ); + }, + ); + }, + child: Card( + key: homeModel?.keySEDateFilter, + color: Theme.of(context) + .colorScheme + .onPrimary, + child: Container( + padding: const EdgeInsets.symmetric( + vertical: 12, + ), + // width: SizeConfig.screenWidth! * 0.30, + child: Row( + mainAxisAlignment: + MainAxisAlignment.spaceEvenly, + children: [ + const Icon( + Icons.calendar_today, + color: Color(0xff524F4F), + ), + const SizedBox( + width: 8, + ), + Text( + AppLocalizations.of(context)! + .strictTranslate( + "Add Date", + ), + ), + ], + ), + ), + ), + ), + ), + Expanded( + flex: 1, + child: Card( + color: Theme.of(context) + .colorScheme + .onPrimary, + child: IconButton( + onPressed: () { + navigationService.pushScreen( + Routes.calendar, + arguments: model.events, + ); + }, + icon: const Icon( + Icons.calendar_month, + ), + ), + ), + ), + ], + ), + 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. + model.events.isEmpty + ? SizedBox( + height: SizeConfig.screenHeight! * 0.5, + child: Center( + child: Text(model.emptyListMessage), + ), + ) + : ListView.builder( + physics: + const NeverScrollableScrollPhysics(), + shrinkWrap: true, + itemCount: model.events.length, + itemBuilder: + (BuildContext context, int index) { + return GestureDetector( + onTap: () { + navigationService.pushScreen( + "/eventInfo", + arguments: { + "event": model.events[index], + "exploreEventViewModel": model + }, + ); + }, + child: EventCard( + event: model.events[index], + isSearchItem: false, + ), + ); + }, + ), + ], + ), + ), + ), + ], + ), + ), + floatingActionButton: FloatingActionButton.extended( + key: homeModel?.keySEAdd, + heroTag: "AddEventFab", + backgroundColor: Theme.of(context).colorScheme.background, + onPressed: () { + navigationService.pushScreen( + "/createEventPage", + ); + }, + icon: Icon( + Icons.add, + color: Theme.of(context).colorScheme.secondary, + ), + label: Text( + AppLocalizations.of(context)!.strictTranslate("Event"), + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith(color: Theme.of(context).colorScheme.secondary), + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md new file mode 100644 index 0000000000..ab1c95642e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/dropDownList.md @@ -0,0 +1,71 @@ + + + +# dropDownList method + + + + + + + + +[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
  • +
+ + + +## Implementation + +```dart +Widget dropDownList(ExploreEventsViewModel model, BuildContext context) { + return DropdownButton( + key: homeModel?.keySECategoryMenu, + value: model.chosenValue, + isExpanded: true, + items: [ + 'All Events', + 'Created Events', + 'Registered Events', + 'Public Events', + 'Private Events', + ].map>((String value) { + return DropdownMenuItem( + value: value, + child: Text( + AppLocalizations.of(context)!.strictTranslate(value), + style: Theme.of(context) + .textTheme + .titleLarge! + .copyWith(color: Theme.of(context).colorScheme.secondary), + ), + ); + }).toList(), + onChanged: (value) { + model.choseValueFromDropdown(value!); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md new file mode 100644 index 0000000000..57574b7829 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/ExploreEvents/homeModel.md @@ -0,0 +1,33 @@ + + + +# homeModel property + + + + + + + +[MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel + +_final_ + + + +

homeModal is a type of MainScreenViewModel which provides methods to handle the data for this component.

+ + + +## Implementation + +```dart +final MainScreenViewModel? homeModel; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_events_explore_events/views_after_auth_screens_events_explore_events-library.md b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/views_after_auth_screens_events_explore_events-library.md new file mode 100644 index 0000000000..0e0ef06bad --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_events_explore_events/views_after_auth_screens_events_explore_events-library.md @@ -0,0 +1,38 @@ + + + + +# explore_events library + + + + + + + + + + + +## Classes + +##### [ExploreEvents](../views_after_auth_screens_events_explore_events/ExploreEvents-class.md) + + + +Shows the list of events with options to categorize them. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md new file mode 100644 index 0000000000..fb53308d80 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate-class.md @@ -0,0 +1,198 @@ + + + +# CommentTemplate class + + + + + + + + + +

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) +- CommentTemplate + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [comment](../views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md) → [Comment](../models_comment_comment_model/Comment-class.md) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md new file mode 100644 index 0000000000..03d2489132 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/CommentTemplate.md @@ -0,0 +1,32 @@ + + + +# CommentTemplate constructor + + + + + + +const +CommentTemplate({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Comment](../../models_comment_comment_model/Comment-class.md) comment}) + + + + + +## Implementation + +```dart +const CommentTemplate({ + Key? key, + required this.comment, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md new file mode 100644 index 0000000000..06c25c9349 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/build.md @@ -0,0 +1,105 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + const CircleAvatar(), + Expanded( + child: Container( + decoration: BoxDecoration( + color: Theme.of(context).iconTheme.color!.withOpacity(0.2), + borderRadius: const BorderRadius.all(Radius.circular(8)), + ), + padding: const EdgeInsets.all(16.0), + margin: const EdgeInsets.only(left: 8.0, bottom: 8.0), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Padding( + padding: const EdgeInsets.only(bottom: 8.0), + child: Text( + "${comment.creator!.firstName!} ${comment.creator!.lastName!}", + style: Theme.of(context).textTheme.bodyMedium, + ), + ), + Text( + comment.text!, + style: Theme.of(context) + .textTheme + .bodyLarge! + .copyWith(fontSize: 16.0), + ), + ], + ), + ), + ) + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md new file mode 100644 index 0000000000..c6fe7ea8c0 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/CommentTemplate/comment.md @@ -0,0 +1,32 @@ + + + +# comment property + + + + + + + +[Comment](../../models_comment_comment_model/Comment-class.md) comment + +_final_ + + + + + + +## Implementation + +```dart +final Comment comment; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md new file mode 100644 index 0000000000..9a1ff325d4 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md @@ -0,0 +1,198 @@ + + + +# IndividualPageLikeSection class + + + + + + + + + +

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) +- IndividualPageLikeSection + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md new file mode 100644 index 0000000000..277f839a81 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/IndividualPageLikeSection.md @@ -0,0 +1,32 @@ + + + +# IndividualPageLikeSection constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const IndividualPageLikeSection({ + Key? key, + required this.usersLiked, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md new file mode 100644 index 0000000000..3f7bb9e2c8 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/build.md @@ -0,0 +1,84 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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. + likedUserCircleAvatar(usersLiked[i]) + ], + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md new file mode 100644 index 0000000000..6a93bef904 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPageLikeSection/usersLiked.md @@ -0,0 +1,32 @@ + + + +# usersLiked property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[LikedBy](../../models_post_post_model/LikedBy-class.md)> usersLiked + +_final_ + + + + + + +## Implementation + +```dart +final List usersLiked; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md new file mode 100644 index 0000000000..ee38a46c9e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md @@ -0,0 +1,207 @@ + + + +# IndividualPostCommentSection class + + + + + + + + + +

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) +- IndividualPostCommentSection + + + + + + + + +## 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}) + + _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)> + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [postID](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md new file mode 100644 index 0000000000..211002b58c --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/IndividualPostCommentSection.md @@ -0,0 +1,33 @@ + + + +# IndividualPostCommentSection constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const IndividualPostCommentSection({ + Key? key, + required this.comments, + required this.postID, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md new file mode 100644 index 0000000000..09d6c82d3d --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/build.md @@ -0,0 +1,87 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) async { + await model.initialise(postID); + // print(model.commentList.first.creator); + _commentViewModel = model; + }, + 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. + CommentTemplate(comment: model.commentList[i]) + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md new file mode 100644 index 0000000000..0276c53d66 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/comments.md @@ -0,0 +1,32 @@ + + + +# comments property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Comments](../../models_post_post_model/Comments-class.md)> comments + +_final_ + + + + + + +## Implementation + +```dart +final List comments; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md new file mode 100644 index 0000000000..9e5c5243b3 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostCommentSection/postID.md @@ -0,0 +1,32 @@ + + + +# postID property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) postID + +_final_ + + + + + + +## Implementation + +```dart +final String postID; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md new file mode 100644 index 0000000000..453fc8cf29 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView-class.md @@ -0,0 +1,198 @@ + + + +# IndividualPostView class + + + + + + + + + +

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) +- IndividualPostView + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [post](../views_after_auth_screens_feed_individual_post/IndividualPostView/post.md) → [Post](../models_post_post_model/Post-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md)() _IndividualPostViewState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md new file mode 100644 index 0000000000..46d9635729 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/IndividualPostView.md @@ -0,0 +1,29 @@ + + + +# IndividualPostView constructor + + + + + + +const +IndividualPostView({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [Post](../../models_post_post_model/Post-class.md) post}) + + + + + +## Implementation + +```dart +const IndividualPostView({Key? key, required this.post}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md new file mode 100644 index 0000000000..dfbb3d183a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_IndividualPostViewState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_IndividualPostViewState createState() => _IndividualPostViewState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/post.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/post.md new file mode 100644 index 0000000000..e986becbc0 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/IndividualPostView/post.md @@ -0,0 +1,32 @@ + + + +# post property + + + + + + + +[Post](../../models_post_post_model/Post-class.md) post + +_final_ + + + + + + +## Implementation + +```dart +final Post post; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md new file mode 100644 index 0000000000..a98749bed0 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/buildPadding.md @@ -0,0 +1,44 @@ + + + +# buildPadding function + + + + + + + + + + +[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) + + + + + + + + +## Implementation + +```dart +Padding buildPadding(BuildContext context, String text) { + return Padding( + padding: const EdgeInsets.symmetric(vertical: 8.0), + child: Text( + AppLocalizations.of(context)!.strictTranslate(text), + style: Theme.of(context).textTheme.titleLarge, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md new file mode 100644 index 0000000000..fb2e6b9a92 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/likedUserCircleAvatar.md @@ -0,0 +1,62 @@ + + + +# likedUserCircleAvatar function + + + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Widget likedUserCircleAvatar(LikedBy user) { + return Padding( + padding: const EdgeInsets.only(right: 10.0, bottom: 16.0), + child: Stack( + clipBehavior: Clip.none, + alignment: Alignment.center, + children: [ + const CircleAvatar( + backgroundColor: Color(0xfff2f2f2), + radius: 20, + ), + const Positioned( + top: 30, + right: 0, + bottom: 20, + left: 20, + child: Icon( + Icons.thumb_up, + color: Colors.blue, + size: 20, + ), + ), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md new file mode 100644 index 0000000000..1f2f4b6155 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_individual_post/views_after_auth_screens_feed_individual_post-library.md @@ -0,0 +1,79 @@ + + + + +# individual_post library + + + + + + + + + + + +## Classes + +##### [CommentTemplate](../views_after_auth_screens_feed_individual_post/CommentTemplate-class.md) + + + +CommentTemplate returns a widget of the individual user commented on the post. + + +##### [IndividualPageLikeSection](../views_after_auth_screens_feed_individual_post/IndividualPageLikeSection-class.md) + + + +IndividualPageLikeSection returns a widget that show the list of all the users liked the post. + + +##### [IndividualPostCommentSection](../views_after_auth_screens_feed_individual_post/IndividualPostCommentSection-class.md) + + + +IndividualPostCommentSection returns a widget that show the list of all the users commented on the post. + + +##### [IndividualPostView](../views_after_auth_screens_feed_individual_post/IndividualPostView-class.md) + + + +IndividualPostView returns a widget that has mutable state _IndividualPostViewState. + + + + + + + +## 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) + + + + + + + + +##### [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 returns a widget of the individual user liked the post. + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md new file mode 100644 index 0000000000..8c5de718cf --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md @@ -0,0 +1,207 @@ + + + +# OrganizationFeed class + + + + + + + + + +

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) +- OrganizationFeed + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [forTest](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [homeModel](../views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md) → [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md)? + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md new file mode 100644 index 0000000000..553285ef8d --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/OrganizationFeed.md @@ -0,0 +1,33 @@ + + + +# OrganizationFeed constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const OrganizationFeed({ + required Key key, + this.homeModel, + this.forTest = false, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md new file mode 100644 index 0000000000..271b6e9d50 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/build.md @@ -0,0 +1,130 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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. + backgroundColor: Theme.of(context).primaryColor, + elevation: 0.0, + centerTitle: true, + title: Text( + model.currentOrgName, + key: homeModel?.keySHOrgName, + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + leading: IconButton( + key: homeModel?.keySHMenuIcon, + icon: Icon( + Icons.menu, + color: Theme.of(context).iconTheme.color, + ), + onPressed: () => + MainScreenViewModel.scaffoldKey.currentState!.openDrawer(), + ), + ), + // 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(), + child: ListView( + shrinkWrap: true, + children: [ + // If the organization has pinned posts then renders PinnedPostCarousel widget else Container. + model.pinnedPosts.isNotEmpty + ? PinnedPostCarousel( + key: homeModel?.keySHPinnedPost, + pinnedPosts: model.pinnedPosts, + navigateToPinnedPostPage: + model.navigateToPinnedPostPage, + navigateToIndividualPostPage: + model.navigateToIndividualPage, + ) + : Container(), + // If the organization has posts then renders PostListWidget widget else Container. + model.posts.isNotEmpty + ? PostListWidget( + key: homeModel?.keySHPost, + posts: model.posts, + function: model.navigateToIndividualPage, + ) + : Container(), + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md new file mode 100644 index 0000000000..6505e3f01e --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/forTest.md @@ -0,0 +1,32 @@ + + + +# forTest property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) forTest + +_final_ + + + + + + +## Implementation + +```dart +final bool forTest; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md new file mode 100644 index 0000000000..d7359e0612 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/OrganizationFeed/homeModel.md @@ -0,0 +1,32 @@ + + + +# homeModel property + + + + + + + +[MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel + +_final_ + + + + + + +## Implementation + +```dart +final MainScreenViewModel? homeModel; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/views_after_auth_screens_feed_organization_feed-library.md b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/views_after_auth_screens_feed_organization_feed-library.md new file mode 100644 index 0000000000..b349ef21b2 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_organization_feed/views_after_auth_screens_feed_organization_feed-library.md @@ -0,0 +1,38 @@ + + + + +# organization_feed library + + + + + + + + + + + +## Classes + +##### [OrganizationFeed](../views_after_auth_screens_feed_organization_feed/OrganizationFeed-class.md) + + + +OrganizationFeed returns a widget that shows the feed of the organization. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md new file mode 100644 index 0000000000..03e0b0a904 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md @@ -0,0 +1,198 @@ + + + +# PinnedPostPage class + + + + + + + + + +

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) +- PinnedPostPage + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md new file mode 100644 index 0000000000..e0f59c0c65 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/PinnedPostPage.md @@ -0,0 +1,29 @@ + + + +# PinnedPostPage constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const PinnedPostPage({Key? key, required this.pinnedPosts}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md new file mode 100644 index 0000000000..17efc17683 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/build.md @@ -0,0 +1,87 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + iconTheme: Theme.of(context).iconTheme, + backgroundColor: Theme.of(context).primaryColor, + elevation: 0.0, + title: Text( + AppLocalizations.of(context)!.strictTranslate('Pinned Posts'), + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + ), + body: ListView( + children: [PostListWidget(posts: pinnedPosts)], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md new file mode 100644 index 0000000000..4071846ea2 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/PinnedPostPage/pinnedPosts.md @@ -0,0 +1,32 @@ + + + +# pinnedPosts property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts + +_final_ + + + + + + +## Implementation + +```dart +final List pinnedPosts; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/views_after_auth_screens_feed_pinned_post_page-library.md b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/views_after_auth_screens_feed_pinned_post_page-library.md new file mode 100644 index 0000000000..b53b74bc35 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_feed_pinned_post_page/views_after_auth_screens_feed_pinned_post_page-library.md @@ -0,0 +1,38 @@ + + + + +# pinned_post_page library + + + + + + + + + + + +## Classes + +##### [PinnedPostPage](../views_after_auth_screens_feed_pinned_post_page/PinnedPostPage-class.md) + + + +PinnedPostPage returns a widget that shows the list of all the pinned post. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md new file mode 100644 index 0000000000..c490c40bc3 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md @@ -0,0 +1,198 @@ + + + +# SendAccessRequest class + + + + + + + + + +

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) +- SendAccessRequest + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [org](../views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md) → [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md new file mode 100644 index 0000000000..40408e8de7 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/SendAccessRequest.md @@ -0,0 +1,33 @@ + + + +# SendAccessRequest constructor + + + + + + +const +SendAccessRequest({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org}) + + + + + +## Implementation + +```dart +const SendAccessRequest({ + Key? key, + required this.org, + // required this.model +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md new file mode 100644 index 0000000000..64d8efddeb --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/build.md @@ -0,0 +1,152 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.initialise(org), + builder: (context, model, child) { + return SafeArea( + child: Scaffold( + appBar: AppBar( + backgroundColor: Colors.transparent, + ), + resizeToAvoidBottomInset: false, + body: Column( + mainAxisAlignment: MainAxisAlignment.start, + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Image.asset('assets/images/Group 8948.png'), + Padding( + padding: const EdgeInsets.all(16.0), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Text( + "You need access", + style: AppTheme.title.copyWith(color: AppTheme.white), + ), + const SizedBox( + height: 5, + ), + const Text( + "Request access, or switch to an account with access", + ), + const SizedBox( + height: 20, + ), + Container( + child: TextField( + style: const TextStyle(color: AppTheme.blackPrimary), + minLines: 15, + maxLines: 20, + decoration: InputDecoration( + constraints: const BoxConstraints( + maxWidth: 400, + minWidth: 100, + ), + enabledBorder: UnderlineInputBorder( + borderRadius: BorderRadius.circular(20.0), + borderSide: const BorderSide( + width: 3, + color: Colors.white, + ), + ), + hintText: "Message (optional)", + hintStyle: const TextStyle( + color: AppTheme.blackSecondary, + ), + filled: true, + fillColor: AppTheme.white, + ), + ), + ), + ], + ), + ), + Center( + child: TextButton( + onPressed: () { + model.sendMembershipRequest(); + }, + style: + TextButton.styleFrom(backgroundColor: AppTheme.green), + child: const Text( + "Request Access", + style: TextStyle( + color: AppTheme.white, + ), + ), + ), + ) + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md new file mode 100644 index 0000000000..5aa35421b6 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest/org.md @@ -0,0 +1,32 @@ + + + +# org property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) org + +_final_ + + + + + + +## Implementation + +```dart +final OrgInfo org; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/views_after_auth_screens_join_org_after_auth_access_request_screen-library.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/views_after_auth_screens_join_org_after_auth_access_request_screen-library.md new file mode 100644 index 0000000000..b615cea0e8 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_access_request_screen/views_after_auth_screens_join_org_after_auth_access_request_screen-library.md @@ -0,0 +1,38 @@ + + + + +# access_request_screen library + + + + + + + + + + + +## Classes + +##### [SendAccessRequest](../views_after_auth_screens_join_org_after_auth_access_request_screen/SendAccessRequest-class.md) + + + +requestAccess + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md new file mode 100644 index 0000000000..dfd63ddc79 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md @@ -0,0 +1,207 @@ + + + +# JoinOrganisationAfterAuth class + + + + + + + + + +

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) +- JoinOrganisationAfterAuth + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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 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) + + + +Returns a debug representation of the object that is used by debugging +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) + + + +A string representation of this object. +_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) + + + +Returns a string representation of this node and its descendants. +_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) + + + +Returns a one-line detailed description of the object. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md new file mode 100644 index 0000000000..1b9db464b5 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/JoinOrganisationAfterAuth.md @@ -0,0 +1,30 @@ + + + +# JoinOrganisationAfterAuth constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const JoinOrganisationAfterAuth({Key? key, required this.orgId}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md new file mode 100644 index 0000000000..b5cbaa0c5b --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/build.md @@ -0,0 +1,123 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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 + appBar: AppBar( + centerTitle: true, + // title of the header. + title: Text( + AppLocalizations.of(context)! + .strictTranslate('Join Organisation'), + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + // action button for the option to join the organization using QR code. + actions: [ + IconButton( + icon: const Icon( + Icons.qr_code_scanner, + size: 30, + semanticLabel: 'Join Organisation with QR', + ), + onPressed: () => scanQR(context, model), + ), + ], + ), + body: Column( + children: [ + const Padding( + padding: EdgeInsets.symmetric(horizontal: 12.0), + child: Divider( + color: Colors.grey, + thickness: 2.0, + ), + ), + Expanded( + // if model searching is under process then renders OrganizationSearchList widget + // else renders OrganizationList widget. + child: model.searching + ? OrganizationSearchList(model: model) + : OrganizationList(model: model), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.0215, + ), + ], + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md new file mode 100644 index 0000000000..3171176684 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/orgId.md @@ -0,0 +1,32 @@ + + + +# orgId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) orgId + +_final_ + + + + + + +## Implementation + +```dart +final String orgId; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md new file mode 100644 index 0000000000..f660938f28 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth/scanQR.md @@ -0,0 +1,89 @@ + + + +# scanQR method + + + + + + + + +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) + + + + + +

scanQR returns a widget that is use in joining the organization via the QR code.

+ + + +## Implementation + +```dart +void scanQR(BuildContext context, SelectOrganizationViewModel model) { + showModalBottomSheet( + context: context, + barrierColor: Colors.transparent, + shape: const RoundedRectangleBorder( + borderRadius: BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + ), + builder: (BuildContext context) { + return ClipRRect( + borderRadius: const BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + child: Container( + height: MediaQuery.of(context).size.width, + decoration: BoxDecoration( + color: Theme.of(context).colorScheme.secondary, + ), + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + SizedBox( + height: 250, + width: 250, + child: QRView( + key: model.qrKey, + onQRViewCreated: (controller) => + _onQRViewCreated(controller, model), + overlay: QrScannerOverlayShape( + overlayColor: Theme.of(context).colorScheme.secondary, + borderRadius: 10, + borderLength: 20, + borderWidth: 10, + cutOutSize: 250, + ), + /*overlayMargin: EdgeInsets.all(50)*/ + ), + ), + SizedBox( + height: SizeConfig.safeBlockVertical! * 4, + ), + const Text('Scan QR'), + SizedBox( + height: SizeConfig.safeBlockVertical! * 4, + ) + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth-library.md b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth-library.md new file mode 100644 index 0000000000..d7987c80f5 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/views_after_auth_screens_join_org_after_auth_join_organisation_after_auth-library.md @@ -0,0 +1,38 @@ + + + + +# join_organisation_after_auth library + + + + + + + + + + + +## Classes + +##### [JoinOrganisationAfterAuth](../views_after_auth_screens_join_org_after_auth_join_organisation_after_auth/JoinOrganisationAfterAuth-class.md) + + + +JoinOrganisationAfterAuth returns a widget for page to join the organization just after user authentication. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md new file mode 100644 index 0000000000..62aad17693 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md @@ -0,0 +1,189 @@ + + + +# EditProfilePage class + + + + + + + + + +

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) +- EditProfilePage + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md)() _EditProfilePageState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md new file mode 100644 index 0000000000..54f963a39f --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/EditProfilePage.md @@ -0,0 +1,29 @@ + + + +# EditProfilePage constructor + + + + + + +const +EditProfilePage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const EditProfilePage({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md new file mode 100644 index 0000000000..cb46e96d33 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/EditProfilePage/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_EditProfilePageState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_EditProfilePageState createState() => _EditProfilePageState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/views_after_auth_screens_profile_edit_profile_page-library.md b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/views_after_auth_screens_profile_edit_profile_page-library.md new file mode 100644 index 0000000000..84dd71907d --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_edit_profile_page/views_after_auth_screens_profile_edit_profile_page-library.md @@ -0,0 +1,38 @@ + + + + +# edit_profile_page library + + + + + + + + + + + +## Classes + +##### [EditProfilePage](../views_after_auth_screens_profile_edit_profile_page/EditProfilePage-class.md) + + + +EditProfilePage returns a widget that has mutable state _EditProfilePageState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage-class.md b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage-class.md new file mode 100644 index 0000000000..83715717f3 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage-class.md @@ -0,0 +1,207 @@ + + + +# ProfilePage class + + + + + + + + + +

ProfilePage returns a widget that renders a page of user's profile.

+ + + +**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) +- ProfilePage + + + + + + + + +## Constructors + +[ProfilePage](../views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md) ({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, [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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [homeModel](../views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md) → [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md)? + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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 + + + + + + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md new file mode 100644 index 0000000000..2007523608 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/ProfilePage.md @@ -0,0 +1,32 @@ + + + +# ProfilePage constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const ProfilePage({ + required Key key, + this.homeModel, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md new file mode 100644 index 0000000000..b4a084ed51 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/build.md @@ -0,0 +1,322 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.initialize(), + builder: (context, model, child) { + return Scaffold( + key: model.scaffoldKey, + appBar: AppBar( + backgroundColor: Theme.of(context).primaryColor, + elevation: 0.0, + centerTitle: true, + leading: IconButton( + color: Theme.of(context).iconTheme.color, + icon: const Icon(Icons.menu), + onPressed: () => + MainScreenViewModel.scaffoldKey.currentState!.openDrawer(), + ), + key: const Key("ProfilePageAppBar"), + title: Text( + AppLocalizations.of(context)!.strictTranslate('Profile'), + style: Theme.of(context).textTheme.titleLarge!.copyWith( + fontWeight: FontWeight.w600, + fontSize: 20, + ), + ), + ), + // if data fetching is under process then renders Circular Progress Icon + // else renders the widget. + body: model.isBusy + ? const CircularProgressIndicator() + : SingleChildScrollView( + child: Column( + children: [ + SizedBox( + height: SizeConfig.screenHeight! * 0.01, + ), + CustomListTile( + key: const Key('OptionEditProfile'), + index: 0, + type: TileType.option, + option: Options( + // Avatar + icon: CustomAvatar( + isImageNull: model.currentUser.image == null, + firstAlphabet: + model.currentUser.firstName!.substring(0, 1), + imageUrl: model.currentUser.image, + fontSize: Theme.of(context) + .textTheme + .titleLarge! + .fontSize, + ), + // display first and last name. + title: + '${model.currentUser.firstName!} ${model.currentUser.lastName!}', + // display email address + subtitle: model.currentUser.email!, + // 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: () { + navigationService.pushScreen("/editProfilePage"); + }, + ), + ), + onTapOption: () {}, + ), + const Divider( + thickness: 1, // thickness of the line + indent: + 20, // empty space to the leading edge of divider. + endIndent: + 20, // empty space to the trailing edge of the divider. + color: Colors + .black26, // The color to use when painting the line. + height: 20, // + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.67, + child: Column( + mainAxisAlignment: MainAxisAlignment.start, + children: [ + SizedBox( + height: SizeConfig.screenHeight! * 0.01, + ), + CustomListTile( + key: homeModel!.keySPAppSetting, + index: 0, + type: TileType.option, + option: Options( + icon: Icon( + Icons.phonelink_setup, + color: + Theme.of(context).colorScheme.secondary, + size: 30, + ), + // title for App Settings. + title: AppLocalizations.of(context)! + .strictTranslate('App Settings'), + // display language of the app. + subtitle: + '${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: () { + navigationService + .pushScreen("/appSettingsPage"); + }, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.05, + ), + CustomListTile( + key: const Key('TasksByUser'), + index: 1, + type: TileType.option, + option: Options( + icon: Icon( + Icons.task_outlined, + color: + Theme.of(context).colorScheme.secondary, + size: 30, + ), + // title for My Tasks tile + title: AppLocalizations.of(context)! + .strictTranslate('My Tasks'), + // display subtitle + subtitle: AppLocalizations.of(context)! + .strictTranslate( + "View and edit all tasks created by you", + ), + ), + // 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) + TalawaPluginProvider( + pluginName: "Donation", + visible: true, + child: Column( + children: [ + CustomListTile( + key: homeModel!.keySPDonateUs, + index: 2, + type: TileType.option, + option: Options( + icon: Icon( + Icons.monetization_on, + color: Theme.of(context) + .colorScheme + .secondary, + size: 30, + ), + title: AppLocalizations.of(context)! + .strictTranslate('Donate Us'), + subtitle: AppLocalizations.of(context)! + .strictTranslate( + 'Help us to develop for you', + ), + ), + onTapOption: () => donate(context, model), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.05, + ), + ], + ), + ), + // custom tile for Invitation. + CustomListTile( + key: homeModel!.keySPInvite, + index: 3, + type: TileType.option, + option: Options( + icon: Icon( + Icons.share, + color: + Theme.of(context).colorScheme.secondary, + size: 30, + ), + // title + title: AppLocalizations.of(context)! + .strictTranslate('Invite'), + // subtitle + subtitle: AppLocalizations.of(context)! + .strictTranslate('Invite to org'), + ), + // on tap call the invite function + onTapOption: () => model.invite(context), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.05, + ), + // Custom tile for Logout option. + CustomListTile( + key: homeModel!.keySPLogout, + index: 3, + type: TileType.option, + option: Options( + icon: Icon( + Icons.logout, + color: + Theme.of(context).colorScheme.secondary, + size: 30, + ), + title: AppLocalizations.of(context)! + .strictTranslate('Log out'), + subtitle: AppLocalizations.of(context)! + .strictTranslate('Log out from Talawa'), + ), + // on tap calls the logout function + onTapOption: () => model.logout(context), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.05, + ), + FromPalisadoes(key: homeModel!.keySPPalisadoes), + ], + ), + ) + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md new file mode 100644 index 0000000000..32bb9a58ea --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/donate.md @@ -0,0 +1,302 @@ + + + +# donate method + + + + + + + + +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) + + + + + + + + +## Implementation + +```dart +void donate(BuildContext context, ProfilePageViewModel model) { + showModalBottomSheet( + context: context, + isScrollControlled: true, + shape: const RoundedRectangleBorder( + borderRadius: BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + ), + builder: (BuildContext context) { + return StatefulBuilder( + builder: (context, setState) { + model.attachListener(setState); + return ClipRRect( + borderRadius: const BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + child: SizedBox( + height: model.bottomSheetHeight, + child: Scaffold( + // background color set to Primary + backgroundColor: + Theme.of(context).colorScheme.primaryContainer, + // header + appBar: AppBar( + centerTitle: true, + automaticallyImplyLeading: false, + backgroundColor: Colors.transparent, + elevation: 0.0, + toolbarHeight: SizeConfig.screenHeight! * 0.15, + title: Padding( + padding: const EdgeInsets.only(top: 8.0), + // display title + child: Text( + 'Donating to \n${model.currentOrg.name}', + style: Theme.of(context) + .textTheme + .headlineMedium! + .copyWith(fontSize: 24), + maxLines: 2, + overflow: TextOverflow.ellipsis, + textAlign: TextAlign.center, + ), + ), + actions: [ + Padding( + padding: EdgeInsets.only( + right: 8.0, + top: SizeConfig.screenHeight! * 0.01, + ), + child: IconButton( + icon: Icon( + Icons.cancel, + color: Theme.of(context).colorScheme.primary, + ), + onPressed: model.popBottomSheet, + ), + ) + ], + ), + body: SingleChildScrollView( + // SingleChildScrollView is a box in which a single widget can be scrolled. + child: Column( + crossAxisAlignment: CrossAxisAlignment.center, + mainAxisSize: MainAxisSize.min, + children: [ + SizedBox( + height: SizeConfig.screenWidth! * 0.05, + ), + Text( + 'Please Select and amount', + style: Theme.of(context).textTheme.headlineSmall, + ), + SizedBox( + height: SizeConfig.screenWidth! * 0.05, + ), + Container( + child: Row( + mainAxisAlignment: MainAxisAlignment.spaceEvenly, + // looping through and renders button for donation amounts. + children: List.generate( + 3, + (index) => model.dominationButton( + model.denomination[index], + context, + setState, + ), + ), + ), + ), + SizedBox( + height: SizeConfig.screenWidth! * 0.05, + ), + Text( + 'Or', + style: Theme.of(context).textTheme.headlineSmall, + ), + Text( + 'Input custom amount', + style: Theme.of(context).textTheme.headlineSmall, + ), + SizedBox( + height: SizeConfig.screenWidth! * 0.05, + ), + // containers for custom amount + Container( + padding: EdgeInsets.symmetric( + horizontal: SizeConfig.screenWidth! * 0.05, + ), + child: TextField( + controller: model.donationAmount, + focusNode: model.donationField, + textInputAction: TextInputAction.next, + keyboardType: TextInputType.number, + autofillHints: const [AutofillHints.email], + enableSuggestions: true, + style: Theme.of(context).textTheme.titleLarge, + onChanged: (text) { + setState(() {}); + }, + decoration: InputDecoration( + hintText: AppLocalizations.of(context)! + .translate("Enter donation amount"), + labelText: AppLocalizations.of(context)! + .translate("Enter custom donation amount"), + labelStyle: + Theme.of(context).textTheme.titleMedium, + prefixIcon: GestureDetector( + onTap: () { + model.changeCurrency(context, setState); + }, + child: Padding( + padding: const EdgeInsets.symmetric( + horizontal: 15.0, + ), + child: Row( + mainAxisSize: MainAxisSize.min, + children: [ + Text( + model.donationCurrency, + textAlign: TextAlign.center, + style: Theme.of(context) + .textTheme + .headlineSmall, + ), + const Icon( + Icons.arrow_drop_down_circle_outlined, + ) + ], + ), + ), + ), + enabledBorder: OutlineInputBorder( + borderRadius: const BorderRadius.all( + Radius.circular(12.0), + ), + borderSide: BorderSide( + color: + Theme.of(context).colorScheme.secondary, + width: 2, + ), + ), + focusedBorder: OutlineInputBorder( + borderRadius: const BorderRadius.all( + Radius.circular(10.0), + ), + borderSide: BorderSide( + color: + Theme.of(context).colorScheme.secondary, + ), + ), + ), + ), + ), + SizedBox( + height: SizeConfig.screenWidth! * 0.05, + ), + ElevatedButton( + onPressed: () async { + ///required fields for donation transaction + late final String userId; + late final String orgId; + late final String nameOfOrg; + late final String nameOfUser; + late final String payPalId; + late final double amount; + orgId = model.currentOrg.id!; + userId = model.currentUser.id!; + nameOfUser = + "${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, + displayName: "Talawa", + ), + cardEnabled: true, + ); + + final BraintreeDropInResult? result = + await BraintreeDropIn.start(request); + if (result != null) { + ///saving the donation in server + late final GraphQLClient client = + graphqlConfig.clientToQuery(); + + ///getting transaction id from `brainTree` API + payPalId = result.paymentMethodNonce.nonce; + + final QueryResult donationResult = + await client.mutate( + MutationOptions( + document: gql( + queries.createDonation( + userId, + orgId, + nameOfOrg, + nameOfUser, + payPalId, + amount, + ), + ), + ), + ); + if (donationResult.hasException) { + model.showSnackBar( + "Error occurred while making a donation", + ); + } + + /// 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 + model.donationAmount.text.isEmpty + ? Colors.grey + : Theme.of(context).colorScheme.primary, + ), + ), + child: Text( + 'DONATE', + style: Theme.of(context).textTheme.labelLarge, + ), + ) + ], + ), + ), + ), + ), + ); + }, + ); + }, + ).then((value) => model.updateSheetHeight()); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md new file mode 100644 index 0000000000..d7359e0612 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/ProfilePage/homeModel.md @@ -0,0 +1,32 @@ + + + +# homeModel property + + + + + + + +[MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md)? homeModel + +_final_ + + + + + + +## Implementation + +```dart +final MainScreenViewModel? homeModel; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/views_after_auth_screens_profile_profile_page-library.md b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/views_after_auth_screens_profile_profile_page-library.md new file mode 100644 index 0000000000..7d8218ef74 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_profile_profile_page/views_after_auth_screens_profile_profile_page-library.md @@ -0,0 +1,38 @@ + + + + +# profile_page library + + + + + + + + + + + +## Classes + +##### [ProfilePage](../views_after_auth_screens_profile_profile_page/ProfilePage-class.md) + + + +ProfilePage returns a widget that renders a page of user's profile. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md new file mode 100644 index 0000000000..c140322956 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md @@ -0,0 +1,198 @@ + + + +# CreateTaskPage class + + + + + + + + + +

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) +- CreateTaskPage + + + + + + + + +## 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}) + + _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) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md new file mode 100644 index 0000000000..67c1b703b0 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/CreateTaskPage.md @@ -0,0 +1,29 @@ + + + +# CreateTaskPage constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CreateTaskPage({required this.eventId, Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md new file mode 100644 index 0000000000..b173c4741f --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/build.md @@ -0,0 +1,80 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```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). + return TaskForm( + onSave: () => model.createTask(eventId), + title: 'Create Task', + actionText: 'Add', + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md new file mode 100644 index 0000000000..4ca1b38906 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/CreateTaskPage/eventId.md @@ -0,0 +1,32 @@ + + + +# eventId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId + +_final_ + + + + + + +## Implementation + +```dart +final String eventId; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/views_after_auth_screens_tasks_create_task_page-library.md b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/views_after_auth_screens_tasks_create_task_page-library.md new file mode 100644 index 0000000000..e30821a178 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_create_task_page/views_after_auth_screens_tasks_create_task_page-library.md @@ -0,0 +1,38 @@ + + + + +# create_task_page library + + + + + + + + + + + +## Classes + +##### [CreateTaskPage](../views_after_auth_screens_tasks_create_task_page/CreateTaskPage-class.md) + + + +CreateTaskPage returns a widget for page to create task for the user. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md new file mode 100644 index 0000000000..8a8ff4c7f2 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md @@ -0,0 +1,198 @@ + + + +# EditTaskPage class + + + + + + + + + +

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) +- EditTaskPage + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [task](../views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md) → [Task](../models_task_task_model/Task-class.md) + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md new file mode 100644 index 0000000000..204de2133f --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/EditTaskPage.md @@ -0,0 +1,29 @@ + + + +# EditTaskPage constructor + + + + + + +const +EditTaskPage({required [Task](../../models_task_task_model/Task-class.md) task, [Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const EditTaskPage({required this.task, Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md new file mode 100644 index 0000000000..35493bb5b0 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/build.md @@ -0,0 +1,81 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```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). + return TaskForm( + onSave: () => model.editTask(task.id), + title: 'Edit Task', + actionText: 'Update', + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md new file mode 100644 index 0000000000..3cf99076fd --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/EditTaskPage/task.md @@ -0,0 +1,32 @@ + + + +# task property + + + + + + + +[Task](../../models_task_task_model/Task-class.md) task + +_final_ + + + + + + +## Implementation + +```dart +final Task task; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/views_after_auth_screens_tasks_edit_task_page-library.md b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/views_after_auth_screens_tasks_edit_task_page-library.md new file mode 100644 index 0000000000..58b4e96c10 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_edit_task_page/views_after_auth_screens_tasks_edit_task_page-library.md @@ -0,0 +1,38 @@ + + + + +# edit_task_page library + + + + + + + + + + + +## Classes + +##### [EditTaskPage](../views_after_auth_screens_tasks_edit_task_page/EditTaskPage-class.md) + + + +EditTaskPage returns a widget for page to edit the task for the user. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md new file mode 100644 index 0000000000..25f2d41a0d --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md @@ -0,0 +1,198 @@ + + + +# EventTasksPage class + + + + + + + + + +

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) +- EventTasksPage + + + + + + + + +## 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}) + + _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) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md new file mode 100644 index 0000000000..fcfe45d50f --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/EventTasksPage.md @@ -0,0 +1,29 @@ + + + +# EventTasksPage constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const EventTasksPage({Key? key, required this.eventId}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md new file mode 100644 index 0000000000..a5fc7f8397 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/build.md @@ -0,0 +1,95 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.fetchTasks(eventId), + builder: (_, model, __) { + final tasks = model.tasks; + return RefreshIndicator( + onRefresh: () => model.fetchTasks(eventId), + child: Scaffold( + appBar: AppBar( + title: const Text('Event Tasks'), + ), + // TaskSchedule is custom widget. + body: TaskSchedule(tasks: tasks), + floatingActionButton: FloatingActionButton( + onPressed: () async { + await navigationService.pushScreen( + Routes.addTask, + arguments: eventId, + ); + }, + child: const Icon(Icons.add), + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md new file mode 100644 index 0000000000..4ca1b38906 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/EventTasksPage/eventId.md @@ -0,0 +1,32 @@ + + + +# eventId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) eventId + +_final_ + + + + + + +## Implementation + +```dart +final String eventId; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/views_after_auth_screens_tasks_event_tasks_page-library.md b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/views_after_auth_screens_tasks_event_tasks_page-library.md new file mode 100644 index 0000000000..47d26bcc29 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_event_tasks_page/views_after_auth_screens_tasks_event_tasks_page-library.md @@ -0,0 +1,38 @@ + + + + +# event_tasks_page library + + + + + + + + + + + +## Classes + +##### [EventTasksPage](../views_after_auth_screens_tasks_event_tasks_page/EventTasksPage-class.md) + + + +EventTasksPage return a widget for Event Task Page that is created by event creator. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md new file mode 100644 index 0000000000..ca207fe6d5 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md @@ -0,0 +1,189 @@ + + + +# UserTasksPage class + + + + + + + + + +

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) +- UserTasksPage + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md new file mode 100644 index 0000000000..2263a899cf --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/UserTasksPage.md @@ -0,0 +1,29 @@ + + + +# UserTasksPage constructor + + + + + + +const +UserTasksPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const UserTasksPage({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md new file mode 100644 index 0000000000..2a4d3e2ccc --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/UserTasksPage/build.md @@ -0,0 +1,86 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.fetchTasksByUser(), + builder: (_, model, __) { + final tasks = model.tasks; + return RefreshIndicator( + onRefresh: () => model.fetchTasksByUser(), + child: Scaffold( + appBar: AppBar( + title: const Text('User Tasks'), + ), + // TaskSchedule is custom widget. + body: TaskSchedule(tasks: tasks, showMoreOptions: true), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/views_after_auth_screens_tasks_user_tasks_page-library.md b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/views_after_auth_screens_tasks_user_tasks_page-library.md new file mode 100644 index 0000000000..8e4e1e0556 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_tasks_user_tasks_page/views_after_auth_screens_tasks_user_tasks_page-library.md @@ -0,0 +1,38 @@ + + + + +# user_tasks_page library + + + + + + + + + + + +## Classes + +##### [UserTasksPage](../views_after_auth_screens_tasks_user_tasks_page/UserTasksPage-class.md) + + + +UserTasksPage returns a widget for page of User Tasks. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md new file mode 100644 index 0000000000..c5eaefb15a --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen-class.md @@ -0,0 +1,216 @@ + + + +# MapScreen class + + + + + + + + + +

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) +- MapScreen + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [latitude](../views_after_auth_screens_venue_map_screen/MapScreen/latitude.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html) + + + + +_final_ + + + +##### [longitude](../views_after_auth_screens_venue_map_screen/MapScreen/longitude.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html) + + + + +_final_ + + + +##### [model](../views_after_auth_screens_venue_map_screen/MapScreen/model.md) → [CreateEventViewModel](../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? + + + + +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_after_auth_screens_venue_map_screen/MapScreen/createState.md)() _MapScreenState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md new file mode 100644 index 0000000000..c16e8d0beb --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/MapScreen.md @@ -0,0 +1,30 @@ + + + +# MapScreen constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const MapScreen(this.model, this.latitude, this.longitude, {Key? key}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md new file mode 100644 index 0000000000..713d88f2aa --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_MapScreenState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_MapScreenState createState() => _MapScreenState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/latitude.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/latitude.md new file mode 100644 index 0000000000..6af59a4a55 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/latitude.md @@ -0,0 +1,32 @@ + + + +# latitude property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html) latitude + +_final_ + + + + + + +## Implementation + +```dart +final double latitude; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md new file mode 100644 index 0000000000..7879ff5703 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/longitude.md @@ -0,0 +1,32 @@ + + + +# longitude property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html) longitude + +_final_ + + + + + + +## Implementation + +```dart +final double longitude; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md new file mode 100644 index 0000000000..697bf3c0ce --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/MapScreen/model.md @@ -0,0 +1,32 @@ + + + +# model property + + + + + + + +[CreateEventViewModel](../../view_model_after_auth_view_models_event_view_models_create_event_view_model/CreateEventViewModel-class.md)? model + +_final_ + + + + + + +## Implementation + +```dart +final CreateEventViewModel? model; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/views_after_auth_screens_venue_map_screen-library.md b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/views_after_auth_screens_venue_map_screen-library.md new file mode 100644 index 0000000000..6fc918ae78 --- /dev/null +++ b/talawa-mobile-docs/views_after_auth_screens_venue_map_screen/views_after_auth_screens_venue_map_screen-library.md @@ -0,0 +1,38 @@ + + + + +# map_screen library + + + + + + + + + + + +## Classes + +##### [MapScreen](../views_after_auth_screens_venue_map_screen/MapScreen-class.md) + + + +MapScreen returns a widget that has mutable state _MapScreenState. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_base_view/BaseView-class.md b/talawa-mobile-docs/views_base_view/BaseView-class.md new file mode 100644 index 0000000000..8946f6bb48 --- /dev/null +++ b/talawa-mobile-docs/views_base_view/BaseView-class.md @@ -0,0 +1,206 @@ + + + +# BaseView<T extends ChangeNotifier> class + + + + + + + + + + + + +**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) +- BaseView + + + + + + + + +## 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)?}) + + _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)?) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [onModelReady](../views_base_view/BaseView/onModelReady.md) → (dynamic Function(T)?) + + + + +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_base_view/BaseView/createState.md)() _BaseViewState<T> + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_base_view/BaseView/BaseView.md b/talawa-mobile-docs/views_base_view/BaseView/BaseView.md new file mode 100644 index 0000000000..b2b14d9c9e --- /dev/null +++ b/talawa-mobile-docs/views_base_view/BaseView/BaseView.md @@ -0,0 +1,32 @@ + + + +# BaseView<T extends ChangeNotifier> constructor + + + + + + +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)?}) + + + + + +## Implementation + +```dart +const BaseView({ + required this.builder, + this.onModelReady, +}); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_base_view/BaseView/builder.md b/talawa-mobile-docs/views_base_view/BaseView/builder.md new file mode 100644 index 0000000000..e30644f097 --- /dev/null +++ b/talawa-mobile-docs/views_base_view/BaseView/builder.md @@ -0,0 +1,32 @@ + + + +# builder property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +final Widget Function(BuildContext, T, Widget?) builder; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_base_view/BaseView/createState.md b/talawa-mobile-docs/views_base_view/BaseView/createState.md new file mode 100644 index 0000000000..e14ec4540f --- /dev/null +++ b/talawa-mobile-docs/views_base_view/BaseView/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_BaseViewState<T> createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_BaseViewState createState() => _BaseViewState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_base_view/BaseView/onModelReady.md b/talawa-mobile-docs/views_base_view/BaseView/onModelReady.md new file mode 100644 index 0000000000..2ac8d9e413 --- /dev/null +++ b/talawa-mobile-docs/views_base_view/BaseView/onModelReady.md @@ -0,0 +1,32 @@ + + + +# onModelReady property + + + + + + + +(dynamic Function(T)?) onModelReady + +_final_ + + + + + + +## Implementation + +```dart +final Function(T)? onModelReady; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_base_view/views_base_view-library.md b/talawa-mobile-docs/views_base_view/views_base_view-library.md new file mode 100644 index 0000000000..c235dde85a --- /dev/null +++ b/talawa-mobile-docs/views_base_view/views_base_view-library.md @@ -0,0 +1,38 @@ + + + + +# base_view library + + + + + + + + + + + +## Classes + +##### [BaseView](../views_base_view/BaseView-class.md)<T extends [ChangeNotifier](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html)> + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_main_screen/MainScreen-class.md b/talawa-mobile-docs/views_main_screen/MainScreen-class.md new file mode 100644 index 0000000000..27015e1078 --- /dev/null +++ b/talawa-mobile-docs/views_main_screen/MainScreen-class.md @@ -0,0 +1,197 @@ + + + +# MainScreen class + + + + + + + + + + + + +**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) +- MainScreen + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [mainScreenArgs](../views_main_screen/MainScreen/mainScreenArgs.md) → [MainScreenArgs](../models_mainscreen_navigation_args/MainScreenArgs-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md b/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md new file mode 100644 index 0000000000..bdcd9e82ea --- /dev/null +++ b/talawa-mobile-docs/views_main_screen/MainScreen/MainScreen.md @@ -0,0 +1,29 @@ + + + +# MainScreen constructor + + + + + + +const +MainScreen({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key, required [MainScreenArgs](../../models_mainscreen_navigation_args/MainScreenArgs-class.md) mainScreenArgs}) + + + + + +## Implementation + +```dart +const MainScreen({Key? key, required this.mainScreenArgs}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_main_screen/MainScreen/createState.md b/talawa-mobile-docs/views_main_screen/MainScreen/createState.md new file mode 100644 index 0000000000..6553b20903 --- /dev/null +++ b/talawa-mobile-docs/views_main_screen/MainScreen/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[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 +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +State createState() => _MainScreenState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_main_screen/MainScreen/mainScreenArgs.md b/talawa-mobile-docs/views_main_screen/MainScreen/mainScreenArgs.md new file mode 100644 index 0000000000..5ca52b9850 --- /dev/null +++ b/talawa-mobile-docs/views_main_screen/MainScreen/mainScreenArgs.md @@ -0,0 +1,32 @@ + + + +# mainScreenArgs property + + + + + + + +[MainScreenArgs](../../models_mainscreen_navigation_args/MainScreenArgs-class.md) mainScreenArgs + +_final_ + + + + + + +## Implementation + +```dart +final MainScreenArgs mainScreenArgs; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_main_screen/views_main_screen-library.md b/talawa-mobile-docs/views_main_screen/views_main_screen-library.md new file mode 100644 index 0000000000..f880632edc --- /dev/null +++ b/talawa-mobile-docs/views_main_screen/views_main_screen-library.md @@ -0,0 +1,38 @@ + + + + +# main_screen library + + + + + + + + + + + +## Classes + +##### [MainScreen](../views_main_screen/MainScreen-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md b/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md new file mode 100644 index 0000000000..731c511f03 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass-class.md @@ -0,0 +1,192 @@ + + + +# ChangePass class + + + + + + + + + +

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.

+ + + +**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) +- ChangePass + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_change_password/ChangePass/createState.md)() _ChangePassState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md b/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md new file mode 100644 index 0000000000..1cd9383e76 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/ChangePass.md @@ -0,0 +1,29 @@ + + + +# ChangePass constructor + + + + + + +const +ChangePass({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const ChangePass({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md b/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md new file mode 100644 index 0000000000..895a6ff7fd --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_change_password/ChangePass/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_ChangePassState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_ChangePassState createState() => _ChangePassState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_change_password/views_pre_auth_screens_change_password-library.md b/talawa-mobile-docs/views_pre_auth_screens_change_password/views_pre_auth_screens_change_password-library.md new file mode 100644 index 0000000000..23eb04bfc7 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_change_password/views_pre_auth_screens_change_password-library.md @@ -0,0 +1,41 @@ + + + + +# change_password library + + + + + + + + + + + +## Classes + +##### [ChangePass](../views_pre_auth_screens_change_password/ChangePass-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_login/Login-class.md b/talawa-mobile-docs/views_pre_auth_screens_login/Login-class.md new file mode 100644 index 0000000000..70fae78e25 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_login/Login-class.md @@ -0,0 +1,194 @@ + + + +# Login class + + + + + + + + + +

This is the login widget. +There are two input fiels. The first one takes in the email and +the second one takes in the password of the user. +There is also a "Forgot Password" text button, which directs to +the "recover password" screen when pressed. +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) +- Login + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_login/Login/createState.md)() _LoginState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md b/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md new file mode 100644 index 0000000000..286bc4a1e4 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_login/Login/Login.md @@ -0,0 +1,29 @@ + + + +# Login constructor + + + + + + +const +Login({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const Login({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md b/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md new file mode 100644 index 0000000000..15962de2ee --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_login/Login/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_LoginState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_LoginState createState() => _LoginState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_login/views_pre_auth_screens_login-library.md b/talawa-mobile-docs/views_pre_auth_screens_login/views_pre_auth_screens_login-library.md new file mode 100644 index 0000000000..ce705ea1d0 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_login/views_pre_auth_screens_login-library.md @@ -0,0 +1,43 @@ + + + + +# login library + + + + + + + + + + + +## Classes + +##### [Login](../views_pre_auth_screens_login/Login-class.md) + + + +This is the login widget. +There are two input fiels. The first one takes in the email and +the second one takes in the password of the user. +There is also a "Forgot Password" text button, which directs to +the "recover password" screen when pressed. +At the bottom, there is a login button to initiate the login. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_recover/Recover-class.md b/talawa-mobile-docs/views_pre_auth_screens_recover/Recover-class.md new file mode 100644 index 0000000000..729d6af960 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_recover/Recover-class.md @@ -0,0 +1,190 @@ + + + +# Recover class + + + + + + + + + +

This class recovers the users password. +The users needs to enter his/her email and press on the button at the bottom to recover his/her 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) +- [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html) +- Recover + + + + + + + + +## Constructors + +[Recover](../views_pre_auth_screens_recover/Recover/Recover.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_recover/Recover/createState.md)() _RecoverState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md b/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md new file mode 100644 index 0000000000..62e8bdcc42 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/Recover.md @@ -0,0 +1,29 @@ + + + +# Recover constructor + + + + + + +const +Recover({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const Recover({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md b/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md new file mode 100644 index 0000000000..2ba2ecaf89 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_recover/Recover/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_RecoverState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_RecoverState createState() => _RecoverState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_recover/views_pre_auth_screens_recover-library.md b/talawa-mobile-docs/views_pre_auth_screens_recover/views_pre_auth_screens_recover-library.md new file mode 100644 index 0000000000..4847fa5eb7 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_recover/views_pre_auth_screens_recover-library.md @@ -0,0 +1,39 @@ + + + + +# recover library + + + + + + + + + + + +## Classes + +##### [Recover](../views_pre_auth_screens_recover/Recover-class.md) + + + +This class recovers the users password. +The users needs to enter his/her email and press on the button at the bottom to recover his/her password. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage-class.md b/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage-class.md new file mode 100644 index 0000000000..ebdca5873e --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage-class.md @@ -0,0 +1,192 @@ + + + +# SelectLanguage class + + + + + + + + + +

This widget enables us to select a different language. +The default language is English. We can choose among the options to switch the language. +There is a text button at the right bottom of the screen which changes the language when tapped. +The user finally gets redirected to the previous 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) +- SelectLanguage + + + + + + + + +## Constructors + +[SelectLanguage](../views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_select_language/SelectLanguage/createState.md)() _SelectLanguageState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md b/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md new file mode 100644 index 0000000000..e410527619 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/SelectLanguage.md @@ -0,0 +1,29 @@ + + + +# SelectLanguage constructor + + + + + + +const +SelectLanguage({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const SelectLanguage({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md b/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md new file mode 100644 index 0000000000..2428e069e0 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_language/SelectLanguage/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_SelectLanguageState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_SelectLanguageState createState() => _SelectLanguageState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_language/views_pre_auth_screens_select_language-library.md b/talawa-mobile-docs/views_pre_auth_screens_select_language/views_pre_auth_screens_select_language-library.md new file mode 100644 index 0000000000..d177a30d05 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_language/views_pre_auth_screens_select_language-library.md @@ -0,0 +1,41 @@ + + + + +# select_language library + + + + + + + + + + + +## Classes + +##### [SelectLanguage](../views_pre_auth_screens_select_language/SelectLanguage-class.md) + + + +This widget enables us to select a different language. +The default language is English. We can choose among the options to switch the language. +There is a text button at the right bottom of the screen which changes the language when tapped. +The user finally gets redirected to the previous screen. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization-class.md b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization-class.md new file mode 100644 index 0000000000..971cf7ddf4 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization-class.md @@ -0,0 +1,200 @@ + + + +# SelectOrganization class + + + + + + + + + +

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) +- SelectOrganization + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_select_organization/SelectOrganization/createState.md)() _SelectOrganizationState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md new file mode 100644 index 0000000000..e50889bab2 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/SelectOrganization.md @@ -0,0 +1,30 @@ + + + +# SelectOrganization constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const SelectOrganization({required Key key, required this.selectedOrgId}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md new file mode 100644 index 0000000000..f79eaff9e3 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_SelectOrganizationState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_SelectOrganizationState createState() => _SelectOrganizationState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/selectedOrgId.md b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/selectedOrgId.md new file mode 100644 index 0000000000..c195ff6362 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_organization/SelectOrganization/selectedOrgId.md @@ -0,0 +1,33 @@ + + + +# selectedOrgId property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) selectedOrgId + +_final_ + + + +

Contains Integer value for selected org id.

+ + + +## Implementation + +```dart +final String selectedOrgId; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_select_organization/views_pre_auth_screens_select_organization-library.md b/talawa-mobile-docs/views_pre_auth_screens_select_organization/views_pre_auth_screens_select_organization-library.md new file mode 100644 index 0000000000..af27a16c9c --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_select_organization/views_pre_auth_screens_select_organization-library.md @@ -0,0 +1,38 @@ + + + + +# select_organization library + + + + + + + + + + + +## Classes + +##### [SelectOrganization](../views_pre_auth_screens_select_organization/SelectOrganization-class.md) + + + +This widget lets the user select new organizations. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md new file mode 100644 index 0000000000..a79b2add3f --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl-class.md @@ -0,0 +1,203 @@ + + + +# SetUrl class + + + + + + + + + +

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.

+ + + +**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) +- SetUrl + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [uri](../views_pre_auth_screens_set_url/SetUrl/uri.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + +Variable. +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_set_url/SetUrl/createState.md)() _SetUrlState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md new file mode 100644 index 0000000000..aac3a1fadb --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/SetUrl.md @@ -0,0 +1,29 @@ + + + +# SetUrl constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const SetUrl({required Key key, required this.uri}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md new file mode 100644 index 0000000000..90d6901db7 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_SetUrlState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_SetUrlState createState() => _SetUrlState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/uri.md b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/uri.md new file mode 100644 index 0000000000..4eb44bdd76 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_set_url/SetUrl/uri.md @@ -0,0 +1,33 @@ + + + +# uri property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) uri + +_final_ + + + +

Variable.

+ + + +## Implementation + +```dart +final String uri; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_set_url/views_pre_auth_screens_set_url-library.md b/talawa-mobile-docs/views_pre_auth_screens_set_url/views_pre_auth_screens_set_url-library.md new file mode 100644 index 0000000000..3947441b15 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_set_url/views_pre_auth_screens_set_url-library.md @@ -0,0 +1,38 @@ + + + + +# set_url library + + + + + + + + + + + +## Classes + +##### [SetUrl](../views_pre_auth_screens_set_url/SetUrl-class.md) + + + +This widget lets a user sign in/up with the organization url. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md new file mode 100644 index 0000000000..dc5cf6e2af --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails-class.md @@ -0,0 +1,198 @@ + + + +# SignUpDetails class + + + + + + + + + +

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) +- SignUpDetails + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [selectedOrg](../views_pre_auth_screens_signup_details/SignUpDetails/selectedOrg.md) → [OrgInfo](../models_organization_org_info/OrgInfo-class.md) + + + + +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../views_pre_auth_screens_signup_details/SignUpDetails/createState.md)() _SignUpDetailsState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md new file mode 100644 index 0000000000..730d0de632 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/SignUpDetails.md @@ -0,0 +1,30 @@ + + + +# SignUpDetails constructor + + + + + + +const +SignUpDetails({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key, required [OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrg}) + + + + + +## Implementation + +```dart +const SignUpDetails({required Key key, required this.selectedOrg}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md new file mode 100644 index 0000000000..d63614dd69 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_SignUpDetailsState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_SignUpDetailsState createState() => _SignUpDetailsState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/selectedOrg.md b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/selectedOrg.md new file mode 100644 index 0000000000..93ed4601a4 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_signup_details/SignUpDetails/selectedOrg.md @@ -0,0 +1,32 @@ + + + +# selectedOrg property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md) selectedOrg + +_final_ + + + + + + +## Implementation + +```dart +final OrgInfo selectedOrg; +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_signup_details/views_pre_auth_screens_signup_details-library.md b/talawa-mobile-docs/views_pre_auth_screens_signup_details/views_pre_auth_screens_signup_details-library.md new file mode 100644 index 0000000000..4198a4f70b --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_signup_details/views_pre_auth_screens_signup_details-library.md @@ -0,0 +1,38 @@ + + + + +# signup_details library + + + + + + + + + + + +## Classes + +##### [SignUpDetails](../views_pre_auth_screens_signup_details/SignUpDetails-class.md) + + + +This widget takes the user details for signup. The form includes first name, last name, email, password, and password confirmation inputs. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md new file mode 100644 index 0000000000..bb3e35ccf1 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md @@ -0,0 +1,189 @@ + + + +# WaitingPage class + + + + + + + + + +

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) +- WaitingPage + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md new file mode 100644 index 0000000000..e02f652098 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/WaitingPage.md @@ -0,0 +1,29 @@ + + + +# WaitingPage constructor + + + + + + +const +WaitingPage({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const WaitingPage({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md new file mode 100644 index 0000000000..853022b40f --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/WaitingPage/build.md @@ -0,0 +1,179 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.initialise(context), + builder: (context, model, child) { + return Scaffold( + key: const Key('WaitingPageScaffold'), + extendBodyBehindAppBar: true, + appBar: AppBar( + elevation: 0.0, + backgroundColor: Colors.transparent, + automaticallyImplyLeading: false, + ), + body: Container( + padding: EdgeInsets.only(top: SizeConfig.safeBlockVertical! * 6), + child: Column( + mainAxisAlignment: MainAxisAlignment.start, + crossAxisAlignment: CrossAxisAlignment.center, + children: [ + SignupProgressIndicator( + key: const Key('Waiting'), + currentPageIndex: 2, + ), + Container( + margin: EdgeInsets.fromLTRB( + SizeConfig.screenWidth! * 0.06, + SizeConfig.screenHeight! * 0.01, + SizeConfig.screenWidth! * 0.06, + SizeConfig.screenHeight! * 0.01, + ), + width: SizeConfig.screenWidth, + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + //Greeting text + CustomRichText( + key: const Key('WaitingPageText'), + words: model.greeting, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.03, + ), + Text( + AppLocalizations.of(context)! + .strictTranslate('Request Sent to'), + style: Theme.of(context).textTheme.titleLarge, + ), + ], + ), + ), + //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) { + return CustomListTile( + key: const Key('WaitingJoin'), + index: index, + type: TileType.org, + orgInfo: model.pendingRequestOrg[index], + onTapOrgInfo: (item) {}, + ); + }, + ), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.0215, + ), + //Join organization button + RaisedRoundedButton( + key: const Key('JoinOrg'), + buttonLabel: AppLocalizations.of(context)! + .strictTranslate('Join Organisation'), + onTap: model.joinOrg, + showArrow: true, + textColor: Theme.of(context).colorScheme.secondaryContainer, + backgroundColor: Theme.of(context) + .inputDecorationTheme + .focusedBorder! + .borderSide + .color, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.0215, + ), + //Logout button + RaisedRoundedButton( + key: const Key('Logout'), + buttonLabel: + AppLocalizations.of(context)!.strictTranslate('Log out'), + onTap: model.logout, + textColor: Theme.of(context) + .inputDecorationTheme + .focusedBorder! + .borderSide + .color, + backgroundColor: + Theme.of(context).colorScheme.secondaryContainer, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.0215, + ), + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/views_pre_auth_screens_waiting_to_join_private_org-library.md b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/views_pre_auth_screens_waiting_to_join_private_org-library.md new file mode 100644 index 0000000000..baca98c973 --- /dev/null +++ b/talawa-mobile-docs/views_pre_auth_screens_waiting_to_join_private_org/views_pre_auth_screens_waiting_to_join_private_org-library.md @@ -0,0 +1,38 @@ + + + + +# waiting_to_join_private_org library + + + + + + + + + + + +## Classes + +##### [WaitingPage](../views_pre_auth_screens_waiting_to_join_private_org/WaitingPage-class.md) + + + +This class returns a widget which shows the request sent by the user to join a private organization. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md b/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md new file mode 100644 index 0000000000..fd1368ae64 --- /dev/null +++ b/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet-class.md @@ -0,0 +1,101 @@ + + + +# EventBottomSheet class + + + + + + + + + +

Adds members to an event.

+ + + + +## Constructors + +[EventBottomSheet](../widgets_add_members_bottom_sheet/EventBottomSheet/EventBottomSheet.md) () + + + + +## Properties + +##### [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_ + + + +##### [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_ + + + + + +## 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 + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/EventBottomSheet.md b/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/EventBottomSheet.md new file mode 100644 index 0000000000..588e22a0a7 --- /dev/null +++ b/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/EventBottomSheet.md @@ -0,0 +1,24 @@ + + + +# EventBottomSheet constructor + + + + + + + +EventBottomSheet() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md b/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md new file mode 100644 index 0000000000..c3727ed088 --- /dev/null +++ b/talawa-mobile-docs/widgets_add_members_bottom_sheet/EventBottomSheet/addUserBottomSheet.md @@ -0,0 +1,148 @@ + + + +# addUserBottomSheet method + + + + + + + + +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}) + + + + + +

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({ + required BuildContext context, + required CreateEventViewModel model, +}) { + // Returns a Future that resolves to the value ("context") passed + // to Navigator.pop + showModalBottomSheet( + context: context, + shape: const RoundedRectangleBorder( + borderRadius: BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + ), + isScrollControlled: true, + builder: (BuildContext context) { + return StatefulBuilder( + builder: (BuildContext context, StateSetter setState) { + return ClipRRect( + borderRadius: const BorderRadius.only( + topLeft: Radius.circular(30), + topRight: Radius.circular(30), + ), + child: Container( + height: MediaQuery.of(context).size.height * 0.8, + decoration: BoxDecoration( + color: Theme.of(context).scaffoldBackgroundColor, + ), + child: Padding( + padding: const EdgeInsets.all(10), + child: Column( + children: [ + const Text( + "Add Members", + style: TextStyle(fontSize: 16), + ), + TextButton( + key: const Key('text_btn_ambs1'), + 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 + future: model.getCurrentOrgUsersList(), + builder: ( + BuildContext context, + AsyncSnapshot> snapshot, + ) { + if (snapshot.data == null) { + return const Center( + child: CircularProgressIndicator(), + ); + } else { + return snapshot.data!.isEmpty + ? const Center( + child: Text( + "There aren't any members in this organization.", + ), + ) + // Displaying the list of the members + : Flexible( + child: ListView.builder( + shrinkWrap: true, + itemCount: snapshot.data!.length, + itemBuilder: (context, index) { + return CheckboxListTile( + checkColor: Theme.of(context) + .colorScheme + .background, + activeColor: Theme.of(context) + .colorScheme + .primary, + title: Text( + "${snapshot.data![index].firstName!} ${snapshot.data![index].lastName!}", + ), + value: model.memberCheckedMap[ + snapshot.data![index].id], + onChanged: (val) { + setState( + () { + model.memberCheckedMap[snapshot + .data![index].id!] = val!; + }, + ); + }, + ); + }, + ), + ); + } + }, + ) + ], + ), + ), + ), + ); + }, + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_add_members_bottom_sheet/widgets_add_members_bottom_sheet-library.md b/talawa-mobile-docs/widgets_add_members_bottom_sheet/widgets_add_members_bottom_sheet-library.md new file mode 100644 index 0000000000..852972d89a --- /dev/null +++ b/talawa-mobile-docs/widgets_add_members_bottom_sheet/widgets_add_members_bottom_sheet-library.md @@ -0,0 +1,38 @@ + + + + +# add_members_bottom_sheet library + + + + + + + + + + + +## Classes + +##### [EventBottomSheet](../widgets_add_members_bottom_sheet/EventBottomSheet-class.md) + + + +Adds members to an event. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md new file mode 100644 index 0000000000..7cdcf62e30 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog-class.md @@ -0,0 +1,255 @@ + + + +# CustomAlertDialog class + + + + + + + + + +

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.

+ + + +**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) +- CustomAlertDialog + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [dialogSubTitle](../widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [dialogTitle](../widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [reverse](../widgets_custom_alert_dialog/CustomAlertDialog/reverse.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [secondaryButtonTap](../widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? + + + + +_final_ + + + +##### [secondaryButtonText](../widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [success](../widgets_custom_alert_dialog/CustomAlertDialog/success.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_final_ + + + +##### [successText](../widgets_custom_alert_dialog/CustomAlertDialog/successText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md new file mode 100644 index 0000000000..8eaaa8ad14 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/CustomAlertDialog.md @@ -0,0 +1,38 @@ + + + +# CustomAlertDialog constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CustomAlertDialog({ + Key? key, + this.successText, + this.dialogTitle, + this.reverse = false, + this.secondaryButtonText = 'Close', + this.secondaryButtonTap, + required this.success, + required this.dialogSubTitle, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md new file mode 100644 index 0000000000..1e95480070 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/build.md @@ -0,0 +1,108 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + final List actions = [ + RaisedRoundedButton( + key: const Key('Close'), + onTap: () => secondaryButtonTap ?? navigationService.pop(), + buttonLabel: + AppLocalizations.of(context)!.strictTranslate(secondaryButtonText), + textColor: Colors.white, + backgroundColor: const Color(0xFF008A37), + width: SizeConfig.screenWidth! * 0.2, + height: SizeConfig.screenHeight! * 0.06, + ), + RaisedRoundedButton( + key: Key(successText ?? 'Confirm'), + onTap: () => success(), + buttonLabel: successText ?? + AppLocalizations.of(context)!.strictTranslate('Confirm'), + textColor: const Color(0xFF008A37), + backgroundColor: Colors.white, + width: SizeConfig.screenWidth! * 0.2, + height: SizeConfig.screenHeight! * 0.06, + ) + ]; + return AlertDialog( + title: Text( + dialogTitle ?? + AppLocalizations.of(context)!.strictTranslate('Confirmation'), + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith(fontWeight: FontWeight.w800), + ), + content: Text(dialogSubTitle), + buttonPadding: EdgeInsets.symmetric( + horizontal: SizeConfig.screenWidth! * 0.05, + vertical: SizeConfig.screenHeight! * 0.05, + ), + actions: reverse ? actions.reversed.toList() : actions, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md new file mode 100644 index 0000000000..289f53404a --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogSubTitle.md @@ -0,0 +1,32 @@ + + + +# dialogSubTitle property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) dialogSubTitle + +_final_ + + + + + + +## Implementation + +```dart +final String dialogSubTitle; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md new file mode 100644 index 0000000000..e9b1201be3 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/dialogTitle.md @@ -0,0 +1,32 @@ + + + +# dialogTitle property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? dialogTitle + +_final_ + + + + + + +## Implementation + +```dart +final String? dialogTitle; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md new file mode 100644 index 0000000000..1a6ef66a47 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/reverse.md @@ -0,0 +1,32 @@ + + + +# reverse property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) reverse + +_final_ + + + + + + +## Implementation + +```dart +final bool reverse; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md new file mode 100644 index 0000000000..69581557bc --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonTap.md @@ -0,0 +1,32 @@ + + + +# secondaryButtonTap property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? secondaryButtonTap + +_final_ + + + + + + +## Implementation + +```dart +final Function? secondaryButtonTap; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md new file mode 100644 index 0000000000..d56250bfc8 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/secondaryButtonText.md @@ -0,0 +1,32 @@ + + + +# secondaryButtonText property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) secondaryButtonText + +_final_ + + + + + + +## Implementation + +```dart +final String secondaryButtonText; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md new file mode 100644 index 0000000000..5a38d96330 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/success.md @@ -0,0 +1,32 @@ + + + +# success property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) success + +_final_ + + + + + + +## Implementation + +```dart +final Function success; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md new file mode 100644 index 0000000000..bae6cfb7b9 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/CustomAlertDialog/successText.md @@ -0,0 +1,32 @@ + + + +# successText property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? successText + +_final_ + + + + + + +## Implementation + +```dart +final String? successText; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_alert_dialog/widgets_custom_alert_dialog-library.md b/talawa-mobile-docs/widgets_custom_alert_dialog/widgets_custom_alert_dialog-library.md new file mode 100644 index 0000000000..04914c600b --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_alert_dialog/widgets_custom_alert_dialog-library.md @@ -0,0 +1,41 @@ + + + + +# custom_alert_dialog library + + + + + + + + + + + +## Classes + +##### [CustomAlertDialog](../widgets_custom_alert_dialog/CustomAlertDialog-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md new file mode 100644 index 0000000000..b17358fbab --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar-class.md @@ -0,0 +1,236 @@ + + + +# CustomAvatar class + + + + + + + + + +

Creates a custom avatar. +The avatar is created using the image provided, +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) +- CustomAvatar + + + + + + + + +## 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}) + + _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)? + + + + +_final_ + + + +##### [firstAlphabet](../widgets_custom_avatar/CustomAvatar/firstAlphabet.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [fontSize](../widgets_custom_avatar/CustomAvatar/fontSize.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_final_ + + + +##### [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_ + + + +##### [imageUrl](../widgets_custom_avatar/CustomAvatar/imageUrl.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [isImageNull](../widgets_custom_avatar/CustomAvatar/isImageNull.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md new file mode 100644 index 0000000000..6889bbd2ef --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/CustomAvatar.md @@ -0,0 +1,36 @@ + + + +# CustomAvatar constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CustomAvatar({ + Key? key, + required this.isImageNull, + this.firstAlphabet, + this.cacheManager, + this.imageUrl, + this.fontSize = 40, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md new file mode 100644 index 0000000000..94273da49a --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/build.md @@ -0,0 +1,106 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return isImageNull + //creating the avatar with the icon-theme color when the image is null + ? CircleAvatar( + backgroundColor: + Theme.of(context).iconTheme.color!.withOpacity(0.2), + child: Center( + child: Text( + firstAlphabet!, + style: Theme.of(context) + .textTheme + .bodyMedium! + .copyWith(fontSize: fontSize), + ), + ), + ) + //creating the avatar with the provided image + : CachedNetworkImage( + cacheManager: cacheManager, + imageBuilder: (context, imageProvider) { + return CircleAvatar( + backgroundColor: + Theme.of(context).iconTheme.color!.withOpacity(0.2), + backgroundImage: imageProvider, + ); + }, + imageUrl: imageUrl!, + placeholder: (context, url) => CircleAvatar( + child: Shimmer.fromColors( + baseColor: Colors.transparent, + highlightColor: Colors.white30, + child: const CircleAvatar(), + ), + ), + errorWidget: (context, url, error) => + const CircleAvatar(child: Icon(Icons.error)), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md new file mode 100644 index 0000000000..64667e8001 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/cacheManager.md @@ -0,0 +1,32 @@ + + + +# cacheManager property + + + + + + + +[BaseCacheManager](https://pub.dev/documentation/flutter_cache_manager/3.3.1/flutter_cache_manager/BaseCacheManager-class.html)? cacheManager + +_final_ + + + + + + +## Implementation + +```dart +final BaseCacheManager? cacheManager; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md new file mode 100644 index 0000000000..ae1ab0c5f8 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/firstAlphabet.md @@ -0,0 +1,32 @@ + + + +# firstAlphabet property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? firstAlphabet + +_final_ + + + + + + +## Implementation + +```dart +final String? firstAlphabet; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md new file mode 100644 index 0000000000..67ce198505 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/fontSize.md @@ -0,0 +1,32 @@ + + + +# fontSize property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? fontSize + +_final_ + + + + + + +## Implementation + +```dart +final double? fontSize; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md new file mode 100644 index 0000000000..c1aab3120c --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/imageUrl.md @@ -0,0 +1,32 @@ + + + +# imageUrl property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? imageUrl + +_final_ + + + + + + +## Implementation + +```dart +final String? imageUrl; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md new file mode 100644 index 0000000000..2485f03e95 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/CustomAvatar/isImageNull.md @@ -0,0 +1,32 @@ + + + +# isImageNull property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isImageNull + +_final_ + + + + + + +## Implementation + +```dart +final bool isImageNull; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_avatar/widgets_custom_avatar-library.md b/talawa-mobile-docs/widgets_custom_avatar/widgets_custom_avatar-library.md new file mode 100644 index 0000000000..b111995673 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_avatar/widgets_custom_avatar-library.md @@ -0,0 +1,40 @@ + + + + +# custom_avatar library + + + + + + + + + + + +## Classes + +##### [CustomAvatar](../widgets_custom_avatar/CustomAvatar-class.md) + + + +Creates a custom avatar. +The avatar is created using the image provided, +or the first alphabet with a standard background color. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md new file mode 100644 index 0000000000..d50b757b4d --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer-class.md @@ -0,0 +1,208 @@ + + + +# CustomDrawer class + + + + + + + + + +

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) +- CustomDrawer + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [homeModel](../widgets_custom_drawer/CustomDrawer/homeModel.md) → [MainScreenViewModel](../view_model_main_screen_view_model/MainScreenViewModel-class.md) + + + +home model. +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [exitButton](../widgets_custom_drawer/CustomDrawer/exitButton.md)() void + + + +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 + + + +Invoked when a non-existent method or property is accessed. +_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) + + + +Returns a debug representation of the object that is used by debugging +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) + + + +A string representation of this object. +_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) + + + +Returns a string representation of this node and its descendants. +_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) + + + +Returns a one-line detailed description of the object. +_inherited_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md new file mode 100644 index 0000000000..1a91c48a28 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/CustomDrawer.md @@ -0,0 +1,32 @@ + + + +# CustomDrawer constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CustomDrawer({ + Key? key, + required this.homeModel, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md new file mode 100644 index 0000000000..179b7931f0 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/build.md @@ -0,0 +1,198 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +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, + child: Drawer( + key: const Key("Drawer"), + child: ListView( + children: [ + Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + //A material design Drawer header that identifies the app's user. + UserAccountsDrawerHeader( + currentAccountPicture: CustomAvatar( + isImageNull: model.selectedOrg?.image == null, + imageUrl: model.selectedOrg?.image, + firstAlphabet: model.selectedOrg?.name!.substring(0, 1), + ), + accountName: Column( + key: MainScreenViewModel.keyDrawerCurOrg, + mainAxisAlignment: MainAxisAlignment.end, + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Text( + model.selectedOrg?.name! ?? "NULL", + ), + Text( + AppLocalizations.of(context)! + .strictTranslate("Selected Organization"), + ) + ], + ), + accountEmail: const SizedBox(), + ), + //Tile to Switch organizations + Column( + key: MainScreenViewModel.keyDrawerSwitchableOrg, + children: [ + Padding( + padding: const EdgeInsets.symmetric( + vertical: 5, + horizontal: 8.0, + ), + child: Text( + AppLocalizations.of(context)! + .strictTranslate("Switch Organization"), + style: Theme.of(context).textTheme.titleLarge, + ), + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.41, + child: Scrollbar( + controller: model.controller, + thumbVisibility: true, + child: ListView.builder( + key: const Key("Switching Org"), + controller: model.controller, + padding: EdgeInsets.zero, + itemCount: model.switchAbleOrg.length, + // itemCount: 3, + itemBuilder: (BuildContext context, int index) { + return ListTile( + key: const Key("Org"), + onTap: () => model + .switchOrg(model.switchAbleOrg[index]), + leading: CustomAvatar( + isImageNull: + model.switchAbleOrg[index].image == + null, + imageUrl: model.switchAbleOrg[index].image, + firstAlphabet: model + .switchAbleOrg[index].name! + .substring(0, 1), + fontSize: 18, + ), + title: Text( + model.switchAbleOrg[index].name!, + ), + ); + }, + ), + ), + ), + ], + ), + const Divider(), + // A Tile to join a new organization + ListTile( + key: MainScreenViewModel.keyDrawerJoinOrg, + onTap: () => navigationService + .popAndPushScreen(Routes.joinOrg, arguments: '-1'), + leading: const Icon( + Icons.add, + size: 30, + ), + title: Text( + AppLocalizations.of(context)! + .strictTranslate("Join new Organization"), + ), + ), + ListTile( + key: MainScreenViewModel.keyDrawerLeaveCurrentOrg, + onTap: () => exitButton(), + leading: const Icon(Icons.logout, size: 30), + title: Text( + AppLocalizations.of(context)! + .strictTranslate("Leave Current Organization"), + ), + ), + SizedBox( + key: const Key("Sized Box Drawer"), + height: SizeConfig.screenHeight! * 0.03, + ), + const FromPalisadoes(key: Key("From Palisadoes")), + SizedBox( + key: const Key("Sized BottomBox Drawer"), + height: SizeConfig.screenHeight! * 0.03, + ) + ], + ), + ], + ), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md new file mode 100644 index 0000000000..2d4c0b640c --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/exitButton.md @@ -0,0 +1,51 @@ + + + +# exitButton method + + + + + + + + +void exitButton +() + + + + + +

Button to exit the organization.

+

params: + None

+

returns: + None

+ + + +## Implementation + +```dart +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 + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md new file mode 100644 index 0000000000..310768eb98 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_drawer/CustomDrawer/homeModel.md @@ -0,0 +1,33 @@ + + + +# homeModel property + + + + + + + +[MainScreenViewModel](../../view_model_main_screen_view_model/MainScreenViewModel-class.md) homeModel + +_final_ + + + +

home model.

+ + + +## Implementation + +```dart +final MainScreenViewModel homeModel; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_drawer/widgets_custom_drawer-library.md b/talawa-mobile-docs/widgets_custom_drawer/widgets_custom_drawer-library.md new file mode 100644 index 0000000000..8ae003a916 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_drawer/widgets_custom_drawer-library.md @@ -0,0 +1,38 @@ + + + + +# custom_drawer library + + + + + + + + + + + +## Classes + +##### [CustomDrawer](../widgets_custom_drawer/CustomDrawer-class.md) + + + +Creates a custom drawer for switching organizations. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md new file mode 100644 index 0000000000..1bffb888ce --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile-class.md @@ -0,0 +1,271 @@ + + + +# CustomListTile class + + + + + + + + + +

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) +- CustomListTile + + + + + + + + +## Constructors + +[CustomListTile](../widgets_custom_list_tile/CustomListTile/CustomListTile.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) 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [index](../widgets_custom_list_tile/CustomListTile/index.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [onTapOption](../widgets_custom_list_tile/CustomListTile/onTapOption.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? + + + + +_final_ + + + +##### [onTapOrgInfo](../widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md) → (dynamic Function([OrgInfo](../models_organization_org_info/OrgInfo-class.md))?) + + + + +_final_ + + + +##### [onTapUserInfo](../widgets_custom_list_tile/CustomListTile/onTapUserInfo.md) → (dynamic Function()?) + + + + +_final_ + + + +##### [option](../widgets_custom_list_tile/CustomListTile/option.md) → [Options](../models_options_options/Options-class.md)? + + + + +_final_ + + + +##### [orgInfo](../widgets_custom_list_tile/CustomListTile/orgInfo.md) → [OrgInfo](../models_organization_org_info/OrgInfo-class.md)? + + + + +_final_ + + + +##### [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_ + + + +##### [showIcon](../widgets_custom_list_tile/CustomListTile/showIcon.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [type](../widgets_custom_list_tile/CustomListTile/type.md) → [TileType](../enums_enums/TileType.md) + + + + +_final_ + + + +##### [userInfo](../widgets_custom_list_tile/CustomListTile/userInfo.md) → [User](../models_user_user_info/User-class.md)? + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md new file mode 100644 index 0000000000..3eeda234df --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/CustomListTile.md @@ -0,0 +1,40 @@ + + + +# CustomListTile constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CustomListTile({ + required Key key, + required this.index, + required this.type, + this.showIcon = false, + this.orgInfo, + this.onTapOrgInfo, + this.userInfo, + this.onTapUserInfo, + this.onTapOption, + this.option, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md new file mode 100644 index 0000000000..7f8f54cc08 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/build.md @@ -0,0 +1,143 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return InkWell( + // checking wheather the tapped tile is of user or org. + onTap: () => type == TileType.org + ? onTapOrgInfo!(orgInfo!) + : type == TileType.user + ? onTapUserInfo!() + // ignore: avoid_dynamic_calls + : onTapOption!(), + child: Padding( + padding: const EdgeInsets.all(18.0), + child: Container( + decoration: BoxDecoration( + color: Colors.white, + borderRadius: BorderRadius.circular(20), + ), + height: 70, + child: Row( + children: [ + Expanded( + flex: 3, + child: Padding( + padding: const EdgeInsets.symmetric( + horizontal: 25, + ), + child: Text( + type == TileType.org + ? orgInfo!.name! + : type == TileType.user + ? '${userInfo!.firstName!} ${userInfo!.lastName!}' + : option!.title, + style: type == TileType.org + ? Theme.of(context) + .textTheme + .headlineSmall! + .copyWith(fontSize: 18, color: Colors.black) + : type == TileType.user + ? Theme.of(context) + .textTheme + .titleLarge! + .copyWith(fontSize: 18, color: Colors.black) + : option!.trailingIconButton == null + ? Theme.of(context) + .textTheme + .bodyMedium! + .copyWith(fontSize: 18, color: Colors.black) + : Theme.of(context) + .textTheme + .headlineSmall! + .copyWith( + fontSize: 18, + color: Colors.black, + ), + ), + ), + ), + Expanded( + flex: 1, + child: type != TileType.user + ? type == TileType.org + ? Icon( + orgInfo!.isPublic! ? Icons.lock_open : Icons.lock, + color: orgInfo!.isPublic! + ? const Color(0xFF34AD64) + : const Color(0xffFABC57), + ) + : option!.trailingIconButton ?? const SizedBox() + : const SizedBox(), + ), + ], + ), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md new file mode 100644 index 0000000000..8d38fdfe8c --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/index.md @@ -0,0 +1,32 @@ + + + +# index property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) index + +_final_ + + + + + + +## Implementation + +```dart +final int index; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md new file mode 100644 index 0000000000..1a38e05228 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOption.md @@ -0,0 +1,32 @@ + + + +# onTapOption property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html)? onTapOption + +_final_ + + + + + + +## Implementation + +```dart +final Function? onTapOption; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md new file mode 100644 index 0000000000..c835fb4c1d --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapOrgInfo.md @@ -0,0 +1,32 @@ + + + +# onTapOrgInfo property + + + + + + + +(dynamic Function([OrgInfo](../../models_organization_org_info/OrgInfo-class.md))?) onTapOrgInfo + +_final_ + + + + + + +## Implementation + +```dart +final Function(OrgInfo)? onTapOrgInfo; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md new file mode 100644 index 0000000000..7aed949acf --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/onTapUserInfo.md @@ -0,0 +1,32 @@ + + + +# onTapUserInfo property + + + + + + + +(dynamic Function()?) onTapUserInfo + +_final_ + + + + + + +## Implementation + +```dart +final Function()? onTapUserInfo; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md new file mode 100644 index 0000000000..5ea4119440 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/option.md @@ -0,0 +1,32 @@ + + + +# option property + + + + + + + +[Options](../../models_options_options/Options-class.md)? option + +_final_ + + + + + + +## Implementation + +```dart +final Options? option; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md new file mode 100644 index 0000000000..22dfb8f00f --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/orgInfo.md @@ -0,0 +1,32 @@ + + + +# orgInfo property + + + + + + + +[OrgInfo](../../models_organization_org_info/OrgInfo-class.md)? orgInfo + +_final_ + + + + + + +## Implementation + +```dart +final OrgInfo? orgInfo; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md new file mode 100644 index 0000000000..fff3c932a1 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/showIcon.md @@ -0,0 +1,32 @@ + + + +# showIcon property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showIcon + +_final_ + + + + + + +## Implementation + +```dart +final bool showIcon; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md new file mode 100644 index 0000000000..1b487d7712 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/type.md @@ -0,0 +1,32 @@ + + + +# type property + + + + + + + +[TileType](../../enums_enums/TileType.md) type + +_final_ + + + + + + +## Implementation + +```dart +final TileType type; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md new file mode 100644 index 0000000000..04e9dd9747 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/CustomListTile/userInfo.md @@ -0,0 +1,32 @@ + + + +# userInfo property + + + + + + + +[User](../../models_user_user_info/User-class.md)? userInfo + +_final_ + + + + + + +## Implementation + +```dart +final User? userInfo; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_list_tile/widgets_custom_list_tile-library.md b/talawa-mobile-docs/widgets_custom_list_tile/widgets_custom_list_tile-library.md new file mode 100644 index 0000000000..20f3bdfd35 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_list_tile/widgets_custom_list_tile-library.md @@ -0,0 +1,39 @@ + + + + +# custom_list_tile library + + + + + + + + + + + +## Classes + +##### [CustomListTile](../widgets_custom_list_tile/CustomListTile-class.md) + + + +Returns a widget for rendering Customized tiles. +A Tile shows the org info, user info, options that on tap user & org info. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md b/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md new file mode 100644 index 0000000000..6f3003ddc0 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog-class.md @@ -0,0 +1,191 @@ + + + +# CustomProgressDialog class + + + + + + + + + +

A progress dialogue which shows an activity indicator +spinning clockwise if there is internet connectivity. +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) +- CustomProgressDialog + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md b/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md new file mode 100644 index 0000000000..3dbcc9b6f5 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/CustomProgressDialog.md @@ -0,0 +1,29 @@ + + + +# CustomProgressDialog constructor + + + + + + +const +CustomProgressDialog({required [Key](https://api.flutter.dev/flutter/foundation/Key-class.html) key}) + + + + + +## Implementation + +```dart +const CustomProgressDialog({required Key key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md b/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md new file mode 100644 index 0000000000..543386b093 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_progress_dialog/CustomProgressDialog/build.md @@ -0,0 +1,114 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return BaseView( + onModelReady: (model) => model.initialise(), + builder: (context, model, child) { + return Container( + margin: EdgeInsets.symmetric( + horizontal: SizeConfig.screenWidth! * 0.25, + vertical: SizeConfig.screenHeight! * 0.35, + ), + decoration: BoxDecoration( + color: Theme.of(context).textTheme.titleLarge!.color, + borderRadius: BorderRadius.circular(15), + ), + child: model.connectivityPresent + ? Center( + //An iOS-style activity indicator that spins clockwise. + + child: CupertinoActivityIndicator( + radius: SizeConfig.screenWidth! * 0.065, + ), + ) + // Shows no-internet image and text on no connectivity + : Column( + children: [ + Container( + alignment: Alignment.bottomCenter, + height: SizeConfig.screenWidth! * 0.4, + width: SizeConfig.screenWidth! * 0.4, + padding: const EdgeInsets.only(bottom: 10), + decoration: const BoxDecoration( + image: DecorationImage( + image: AssetImage('assets/images/no_internet.png'), + fit: BoxFit.scaleDown, + ), + ), + ), + Text( + '${AppLocalizations.of(context)!.strictTranslate("No Internet")}!', + style: Theme.of(context).textTheme.headlineSmall, + ), + ], + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_custom_progress_dialog/widgets_custom_progress_dialog-library.md b/talawa-mobile-docs/widgets_custom_progress_dialog/widgets_custom_progress_dialog-library.md new file mode 100644 index 0000000000..6c67685cc0 --- /dev/null +++ b/talawa-mobile-docs/widgets_custom_progress_dialog/widgets_custom_progress_dialog-library.md @@ -0,0 +1,40 @@ + + + + +# custom_progress_dialog library + + + + + + + + + + + +## Classes + +##### [CustomProgressDialog](../widgets_custom_progress_dialog/CustomProgressDialog-class.md) + + + +A progress dialogue which shows an activity indicator +spinning clockwise if there is internet connectivity. +Otherwise, it shows no-internet image and text. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md b/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md new file mode 100644 index 0000000000..be6e41a57b --- /dev/null +++ b/talawa-mobile-docs/widgets_date_time_picker/customDatePicker.md @@ -0,0 +1,51 @@ + + + +# customDatePicker function + + + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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) { + return picked; + } + return initialDate; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md b/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md new file mode 100644 index 0000000000..dbef8ac94e --- /dev/null +++ b/talawa-mobile-docs/widgets_date_time_picker/customTimePicker.md @@ -0,0 +1,51 @@ + + + +# customTimePicker function + + + + + + + + + + +[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.

+ + + +## 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. + final TimeOfDay? pickedTime = await showTimePicker( + context: navigationService.navigatorKey.currentContext!, + initialTime: initialTime, + ); + + if (pickedTime != null && pickedTime != initialTime) { + return pickedTime; + } + return initialTime; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md b/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md new file mode 100644 index 0000000000..2a02458bf7 --- /dev/null +++ b/talawa-mobile-docs/widgets_date_time_picker/widgets_date_time_picker-library.md @@ -0,0 +1,49 @@ + + + + +# date_time_picker library + + + + + + + + + + + + + + + + +## 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)> + + + +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)> + + + +Shows a dialog containing a material design time picker. + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard-class.md b/talawa-mobile-docs/widgets_event_card/EventCard-class.md new file mode 100644 index 0000000000..a823fc9c5f --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard-class.md @@ -0,0 +1,225 @@ + + + +# EventCard class + + + + + + + + + +

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) +- EventCard + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [event](../widgets_event_card/EventCard/event.md) → [Event](../models_events_event_model/Event-class.md) + + + + +_final_ + + + +##### [eventTitleHighlightedText](../widgets_event_card/EventCard/eventTitleHighlightedText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [eventTitleNormalText](../widgets_event_card/EventCard/eventTitleNormalText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [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_ + + + +##### [isSearchItem](../widgets_event_card/EventCard/isSearchItem.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md b/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md new file mode 100644 index 0000000000..f6421729ad --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard/EventCard.md @@ -0,0 +1,35 @@ + + + +# EventCard constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const EventCard({ + Key? key, + required this.event, + this.eventTitleHighlightedText, + this.eventTitleNormalText, + required this.isSearchItem, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard/build.md b/talawa-mobile-docs/widgets_event_card/EventCard/build.md new file mode 100644 index 0000000000..feddc8335c --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard/build.md @@ -0,0 +1,336 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + final bool isRegistered = event.isRegistered ?? false; + return Padding( + padding: const EdgeInsets.only(bottom: 10), + child: Stack( + children: [ + Card( + shape: RoundedRectangleBorder( + side: + isRegistered && userConfig.currentUser.id != event.creator!.id + ? BorderSide( + color: Theme.of(context).colorScheme.secondary, + width: SizeConfig.screenWidth! * 0.008, + ) + : BorderSide.none, + ), + elevation: 3, + color: Theme.of(context).primaryColor, + child: Column( + children: [ + AspectRatio( + aspectRatio: 2.5, + child: Container( + height: SizeConfig.screenHeight! * 0.11, + width: double.infinity, + decoration: BoxDecoration( + color: Colors.grey.withOpacity(0.3), + image: const DecorationImage( + fit: BoxFit.fitWidth, + alignment: FractionalOffset.topCenter, + image: NetworkImage( + 'https://picsum.photos/id/1022/200/300', + ), + ), + ), + child: ClipRRect( + child: BackdropFilter( + filter: ImageFilter.blur(sigmaX: 5, sigmaY: 5), + child: Container( + decoration: BoxDecoration( + color: Colors.white.withOpacity(0.0), + ), + ), + ), + ), + ), + ), + Padding( + padding: const EdgeInsets.all(10), + child: Column( + children: [ + Row( + children: [ + SizedBox( + width: SizeConfig.screenWidth! * 0.48, + child: isSearchItem + ? RichText( + text: TextSpan( + text: eventTitleHighlightedText, + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith( + fontWeight: FontWeight.bold, + ), + children: [ + TextSpan( + text: eventTitleNormalText, + style: Theme.of(context) + .textTheme + .headlineSmall! + .copyWith( + color: Colors.grey, + ), + ) + ], + ), + overflow: TextOverflow.ellipsis, + textAlign: TextAlign.left, + ) + : Text( + event.title!, + style: Theme.of(context) + .textTheme + .headlineSmall, + ), + ), + const Spacer(), + const Icon( + Icons.calendar_today, + size: 13, + ), + const Spacer(), + Text( + "${event.startDate!} - ${event.endDate!}", + style: Theme.of(context).textTheme.bodySmall, + ) + ], + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.006, + ), + Row( + children: [ + const Icon( + Icons.schedule, + size: 12, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.015, + ), + Text( + "${event.startTime!} - ${event.endTime!}", + style: Theme.of(context).textTheme.bodySmall, + ), + const Spacer(), + const Icon( + Icons.place, + size: 12, + ), + SizedBox( + child: Text( + event.location!.substring( + 0, + min(event.location!.length, 20), + ), + style: Theme.of(context).textTheme.bodySmall, + ), + ) + ], + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.013, + ), + Row( + mainAxisAlignment: MainAxisAlignment.spaceBetween, + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + SizedBox( + width: SizeConfig.screenWidth! * 0.55, + child: Text( + event.description!, + style: Theme.of(context).textTheme.bodySmall, + overflow: TextOverflow.ellipsis, + textAlign: TextAlign.left, + maxLines: 3, + ), + ), + const Icon( + Icons.chevron_right, + ), + ], + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.007, + ), + Row( + mainAxisAlignment: MainAxisAlignment.end, + children: [ + userConfig.currentUser.id == event.creator!.id + ? Row( + children: [ + Icon( + Icons.verified, + size: 13, + color: Theme.of(context) + .colorScheme + .secondary, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.013, + ), + Text( + AppLocalizations.of(context)! + .strictTranslate('Created'), + style: + Theme.of(context).textTheme.bodySmall, + ), + ], + ) + : const SizedBox(), + const Spacer(), + event.isPublic! + ? Icon( + Icons.lock_open, + size: 13, + color: Theme.of(context).colorScheme.primary, + ) + : Icon( + Icons.lock, + size: 13, + color: Theme.of(context).colorScheme.primary, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.013, + ), + event.isPublic! + ? Text( + AppLocalizations.of(context)! + .strictTranslate('public'), + style: Theme.of(context).textTheme.bodySmall, + ) + : Text( + AppLocalizations.of(context)! + .strictTranslate('private'), + style: Theme.of(context).textTheme.bodySmall, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.027, + ), + const Icon( + Icons.people_outline, + size: 13, + color: Color(0xff4285F4), + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.013, + ), + event.attendees != null + ? Text( + event.attendees!, + style: Theme.of(context).textTheme.bodySmall, + ) + : Text( + (event.registrants?.length ?? 0).toString(), + style: Theme.of(context).textTheme.bodySmall, + ) + ], + ), + ], + ), + ) + ], + ), + ), + Positioned( + top: SizeConfig.screenHeight! * 0.007, + right: SizeConfig.screenWidth! * 0.013, + child: isRegistered && + userConfig.currentUser.id != event.creator!.id + ? DecoratedBox( + decoration: BoxDecoration( + color: Theme.of(context).colorScheme.secondary, + borderRadius: const BorderRadius.only( + bottomLeft: Radius.circular(15), + ), + ), + child: Padding( + padding: const EdgeInsets.all(8.0), + child: Center( + child: Text( + AppLocalizations.of(context)! + .strictTranslate("Registered"), + style: + Theme.of(context).textTheme.titleLarge!.copyWith( + color: Colors.white, + fontWeight: FontWeight.w700, + ), + ), + ), + ), + ) + : const SizedBox(), + ) + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard/event.md b/talawa-mobile-docs/widgets_event_card/EventCard/event.md new file mode 100644 index 0000000000..9714bc41af --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard/event.md @@ -0,0 +1,32 @@ + + + +# event property + + + + + + + +[Event](../../models_events_event_model/Event-class.md) event + +_final_ + + + + + + +## Implementation + +```dart +final Event event; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md b/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md new file mode 100644 index 0000000000..237bbbb815 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleHighlightedText.md @@ -0,0 +1,32 @@ + + + +# eventTitleHighlightedText property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleHighlightedText + +_final_ + + + + + + +## Implementation + +```dart +final String? eventTitleHighlightedText; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md b/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md new file mode 100644 index 0000000000..bbc1edc6c4 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard/eventTitleNormalText.md @@ -0,0 +1,32 @@ + + + +# eventTitleNormalText property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? eventTitleNormalText + +_final_ + + + + + + +## Implementation + +```dart +final String? eventTitleNormalText; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md b/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md new file mode 100644 index 0000000000..463d3fb1e6 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/EventCard/isSearchItem.md @@ -0,0 +1,32 @@ + + + +# isSearchItem property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) isSearchItem + +_final_ + + + + + + +## Implementation + +```dart +final bool isSearchItem; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_card/widgets_event_card-library.md b/talawa-mobile-docs/widgets_event_card/widgets_event_card-library.md new file mode 100644 index 0000000000..36714b8fc9 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_card/widgets_event_card-library.md @@ -0,0 +1,38 @@ + + + + +# event_card library + + + + + + + + + + + +## Classes + +##### [EventCard](../widgets_event_card/EventCard-class.md) + + + +This class returns the EventCard widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md new file mode 100644 index 0000000000..4e7838b6eb --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile-class.md @@ -0,0 +1,225 @@ + + + +# DateTimeTile class + + + + + + + + + +

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) +- DateTimeTile + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [date](../widgets_event_date_time_tile/DateTimeTile/date.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [setDate](../widgets_event_date_time_tile/DateTimeTile/setDate.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_final_ + + + +##### [setTime](../widgets_event_date_time_tile/DateTimeTile/setTime.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_final_ + + + +##### [time](../widgets_event_date_time_tile/DateTimeTile/time.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md new file mode 100644 index 0000000000..9a12553174 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/DateTimeTile.md @@ -0,0 +1,35 @@ + + + +# DateTimeTile constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const DateTimeTile({ + Key? key, + required this.date, + required this.time, + required this.setDate, + required this.setTime, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md new file mode 100644 index 0000000000..ab4c1078f8 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/build.md @@ -0,0 +1,120 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Container( + color: Theme.of(context).colorScheme.primaryContainer, + height: SizeConfig.screenHeight! * 0.068, + width: double.infinity, + child: Padding( + padding: + EdgeInsets.symmetric(horizontal: SizeConfig.screenWidth! * 0.083), + child: Row( + children: [ + const Icon( + Icons.calendar_today, + color: Color(0xff524F4F), + size: 19, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.045, + ), + InkWell( + key: const Key('EventDateTimeTileDate'), + onTap: () async { + setDate(); + }, + child: Text( + date, + style: const TextStyle(fontSize: 16), + ), + ), + const Spacer(), + const Icon( + Icons.schedule, + color: Color(0xff524F4F), + size: 19, + ), + SizedBox( + width: SizeConfig.screenWidth! * 0.045, + ), + InkWell( + key: const Key('EventDateTimeTileTime'), + onTap: () async { + setTime(); + }, + child: Text( + time, + style: const TextStyle(fontSize: 16), + ), + ), + ], + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md new file mode 100644 index 0000000000..5c32ea33f7 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/date.md @@ -0,0 +1,32 @@ + + + +# date property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) date + +_final_ + + + + + + +## Implementation + +```dart +final String date; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md new file mode 100644 index 0000000000..b07f5810df --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setDate.md @@ -0,0 +1,32 @@ + + + +# setDate property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setDate + +_final_ + + + + + + +## Implementation + +```dart +final Function setDate; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md new file mode 100644 index 0000000000..8ede21b128 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/setTime.md @@ -0,0 +1,32 @@ + + + +# setTime property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) setTime + +_final_ + + + + + + +## Implementation + +```dart +final Function setTime; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md new file mode 100644 index 0000000000..ebc301185c --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/DateTimeTile/time.md @@ -0,0 +1,32 @@ + + + +# time property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) time + +_final_ + + + + + + +## Implementation + +```dart +final String time; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_date_time_tile/widgets_event_date_time_tile-library.md b/talawa-mobile-docs/widgets_event_date_time_tile/widgets_event_date_time_tile-library.md new file mode 100644 index 0000000000..c425fb7a53 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_date_time_tile/widgets_event_date_time_tile-library.md @@ -0,0 +1,38 @@ + + + + +# event_date_time_tile library + + + + + + + + + + + +## Classes + +##### [DateTimeTile](../widgets_event_date_time_tile/DateTimeTile-class.md) + + + +Returns a widget tile(item) for displaying date and time. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md new file mode 100644 index 0000000000..1b25b05d5a --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch-class.md @@ -0,0 +1,279 @@ + + + +# EventSearch class + + + + + + + + + +

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)> +- EventSearch + + + + + + + + +## 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}) + + + + +## 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)> + + + + +_final_ + + + +##### [exploreEventsViewModel](../widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md) ↔ [ExploreEventsViewModel](../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) + + + + +_read / write_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The theme used to configure the search page. +_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)> + + + +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)? + + + +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) + + + +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) + + + +The results shown after the user submits a search from the search page. +_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) + + + +Suggestions shown in the body of the search page while the user types a +query into the search field. +_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) + + + + + + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md new file mode 100644 index 0000000000..63dfbfee05 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/EventSearch.md @@ -0,0 +1,29 @@ + + + +# EventSearch constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +EventSearch({required this.eventList, required this.exploreEventsViewModel}); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md new file mode 100644 index 0000000000..955593cee4 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildActions.md @@ -0,0 +1,57 @@ + + + +# buildActions method + + + + + + + +- @[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) + +_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.
  • +
+ + + +## Implementation + +```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. + return [ + IconButton( + onPressed: () { + query.isNotEmpty ? query = '' : close(context, eventList.first); + }, + icon: const Icon(Icons.clear), + ) + ]; +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md new file mode 100644 index 0000000000..932c3165c8 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildLeading.md @@ -0,0 +1,55 @@ + + + +# buildLeading method + + + + + + + +- @[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) + +_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.
  • +
+ + + +## Implementation + +```dart +@override +Widget buildLeading(BuildContext context) { + /// Returns an icon button which closes the search page and returns + /// to the underlying route + return IconButton( + onPressed: () { + close(context, eventList.first); + }, + icon: const Icon(Icons.arrow_back), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md new file mode 100644 index 0000000000..f2746447d7 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildResults.md @@ -0,0 +1,48 @@ + + + +# buildResults method + + + + + + + +- @[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) + +_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 +with the selected result as argument. This will close the search page and +communicate the result back to the initial caller of showSearch.

+ + + +## Implementation + +```dart +@override +Widget buildResults(BuildContext context) { + return Container(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildSuggestions.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildSuggestions.md new file mode 100644 index 0000000000..214844f007 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildSuggestions.md @@ -0,0 +1,57 @@ + + + +# buildSuggestions method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +[Widget](https://api.flutter.dev/flutter/widgets/Widget-class.html) buildSuggestions +([BuildContext](https://api.flutter.dev/flutter/widgets/BuildContext-class.html) context) + +_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 +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 +with the corresponding suggestion and the results page should be shown +by calling showResults.

+ + + +## Implementation + +```dart +@override +Widget buildSuggestions(BuildContext context) { + /// Returns a scrollable list through "buildSuggestionsSuccess" function. + /// where() method Returns a new lazy Iterable with all elements that satisfy the predicate test. + /// toList( ) method is used to convert an Iterable to a List. + /// toLowerCase() converts all characters in a string to lower case. + final suggestions = eventList.where((event) { + final eventLowerCase = event.title!.toLowerCase(); + final queryLowerCase = query.toLowerCase(); + return eventLowerCase.startsWith(queryLowerCase); + }).toList(); + return buildSuggestionsSucess(suggestions); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildSuggestionsSucess.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildSuggestionsSucess.md new file mode 100644 index 0000000000..f4ebd1ef30 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/buildSuggestionsSucess.md @@ -0,0 +1,71 @@ + + + +# buildSuggestionsSucess method + + + + + + + + +[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) + + + + + + + + +## 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. + return SingleChildScrollView( + child: ListView.builder( + physics: const NeverScrollableScrollPhysics(), + shrinkWrap: true, + itemCount: suggestions.length, + 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. + return GestureDetector( + onTap: () { + navigationService.pushScreen( + "/eventInfo", + arguments: { + "event": suggestions[index], + "exploreEventViewModel": exploreEventsViewModel + }, + ); + }, + child: EventCard( + event: suggestions[index], + isSearchItem: true, + eventTitleHighlightedText: highlightedText, + eventTitleNormalText: normalText, + ), + ); + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md new file mode 100644 index 0000000000..9fb10e4c0e --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/eventList.md @@ -0,0 +1,32 @@ + + + +# eventList property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Event](../../models_events_event_model/Event-class.md)> eventList + +_final_ + + + + + + +## Implementation + +```dart +final List eventList; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md new file mode 100644 index 0000000000..3ca7e2f79b --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/EventSearch/exploreEventsViewModel.md @@ -0,0 +1,32 @@ + + + +# exploreEventsViewModel property + + + + + + + +[ExploreEventsViewModel](../../view_model_after_auth_view_models_event_view_models_explore_events_view_model/ExploreEventsViewModel-class.md) exploreEventsViewModel + +_read / write_ + + + + + + +## Implementation + +```dart +ExploreEventsViewModel exploreEventsViewModel; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_event_search_delegate/widgets_event_search_delegate-library.md b/talawa-mobile-docs/widgets_event_search_delegate/widgets_event_search_delegate-library.md new file mode 100644 index 0000000000..100e00d1b4 --- /dev/null +++ b/talawa-mobile-docs/widgets_event_search_delegate/widgets_event_search_delegate-library.md @@ -0,0 +1,38 @@ + + + + +# event_search_delegate library + + + + + + + + + + + +## Classes + +##### [EventSearch](../widgets_event_search_delegate/EventSearch-class.md) + + + +This class returns a list of the events which match the search query. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md b/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md new file mode 100644 index 0000000000..29596a85e9 --- /dev/null +++ b/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes-class.md @@ -0,0 +1,189 @@ + + + +# FromPalisadoes class + + + + + + + + + +

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) +- FromPalisadoes + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md b/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md new file mode 100644 index 0000000000..2932b6ed57 --- /dev/null +++ b/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/FromPalisadoes.md @@ -0,0 +1,29 @@ + + + +# FromPalisadoes constructor + + + + + + +const +FromPalisadoes({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const FromPalisadoes({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md b/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md new file mode 100644 index 0000000000..e4b6eb4cf7 --- /dev/null +++ b/talawa-mobile-docs/widgets_from_palisadoes/FromPalisadoes/build.md @@ -0,0 +1,106 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Column( + children: [ + // Customizing the word "from". + Row( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Text( + // This method is called for localized text. + AppLocalizations.of(context)!.strictTranslate('from'), + style: Theme.of(context).textTheme.bodySmall, + ), + ], + ), + SizedBox( + height: SizeConfig.blockSizeHorizontal, + ), + // Customizing the word "Palisadoes". + Row( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Text( + 'PALISADOES', + style: Theme.of(context) + .textTheme + .titleSmall! + .copyWith(fontWeight: FontWeight.w700), + ), + ], + ), + SizedBox( + height: SizeConfig.blockSizeHorizontal! * 5, + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_from_palisadoes/widgets_from_palisadoes-library.md b/talawa-mobile-docs/widgets_from_palisadoes/widgets_from_palisadoes-library.md new file mode 100644 index 0000000000..f0fec4648c --- /dev/null +++ b/talawa-mobile-docs/widgets_from_palisadoes/widgets_from_palisadoes-library.md @@ -0,0 +1,38 @@ + + + + +# from_palisadoes library + + + + + + + + + + + +## Classes + +##### [FromPalisadoes](../widgets_from_palisadoes/FromPalisadoes-class.md) + + + +This class generates the text "From Palisadoes" in a custom way. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_invite_child/iconButton.md b/talawa-mobile-docs/widgets_invite_child/iconButton.md new file mode 100644 index 0000000000..69577b9a84 --- /dev/null +++ b/talawa-mobile-docs/widgets_invite_child/iconButton.md @@ -0,0 +1,51 @@ + + + +# iconButton function + + + + + + + + + + +[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.

+ + + +## Implementation + +```dart +Widget iconButton(String key, Widget icon, Function onTap) { + return Stack( + children: [ + IconButton( + key: Key(key), + onPressed: () { + print('tapped'); + onTap(); + }, + icon: icon, + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_invite_child/invite.md b/talawa-mobile-docs/widgets_invite_child/invite.md new file mode 100644 index 0000000000..2b55a998b7 --- /dev/null +++ b/talawa-mobile-docs/widgets_invite_child/invite.md @@ -0,0 +1,122 @@ + + + +# invite function + + + + + + + + + + +[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.

+ + + +## Implementation + +```dart +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!}'; + final String qrData = + '${GraphqlConfig.orgURI}?orgid=${userConfig.currentOrg.id!}'; + + // 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. + QrImage( + key: const Key("QRcode"), + data: qrData, + version: QrVersions.auto, + size: 200.0, + foregroundColor: Colors.black, + ), + SizedBox( + height: SizeConfig.screenHeight! * 0.08, + ), + Text( + '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. + Row( + mainAxisAlignment: MainAxisAlignment.spaceEvenly, + mainAxisSize: MainAxisSize.min, + children: [ + iconButton( + "Twitter", + const FaIcon( + FontAwesomeIcons.twitter, + size: 35, + color: Color(0xFF1DA1F2), + ), + () async => SocialShare.shareTwitter('Join us', url: url), + ), + //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 + painter: WhatsappLogo(), + ), + () async => SocialShare.shareWhatsapp(url), + ), + iconButton( + "Telegram", + CustomPaint( + size: Size( + 45, + (45 * 1).toDouble(), + ), //You can Replace [WIDTH] with your desired width for Custom Paint and height will be calculated automatically + painter: TelegramLogo(), + ), + () async => SocialShare.shareTelegram(url), + ), + iconButton( + "Alt", + const FaIcon( + FontAwesomeIcons.shareNodes, + size: 30, + color: Color(0xff40c351), + ), + () async => SocialShare.shareOptions(url), + ), + ], + ) + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md b/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md new file mode 100644 index 0000000000..dfc730d90a --- /dev/null +++ b/talawa-mobile-docs/widgets_invite_child/widgets_invite_child-library.md @@ -0,0 +1,51 @@ + + + + +# invite_child library + + + + + + + + + + + + + + + + +## 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) + + + +This function is for debugging purposes. +It prints "tapped" in the console for the developer to know that the button was tapped. + + + + +##### [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) + + + +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. + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md b/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md new file mode 100644 index 0000000000..4366406118 --- /dev/null +++ b/talawa-mobile-docs/widgets_lang_switch/LanguageTile-class.md @@ -0,0 +1,189 @@ + + + +# LanguageTile class + + + + + + + + + +

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) +- LanguageTile + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md b/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md new file mode 100644 index 0000000000..34f40dc1f3 --- /dev/null +++ b/talawa-mobile-docs/widgets_lang_switch/LanguageTile/LanguageTile.md @@ -0,0 +1,29 @@ + + + +# LanguageTile constructor + + + + + + +const +LanguageTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const LanguageTile({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md b/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md new file mode 100644 index 0000000000..71ec7fde9a --- /dev/null +++ b/talawa-mobile-docs/widgets_lang_switch/LanguageTile/build.md @@ -0,0 +1,97 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```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, _) { + final Language userLanguage = languages.firstWhere( + (element) => element.langCode == appLang.appLocal.languageCode, + ); + return ListTile( + key: const Key('LanguageTile'), + contentPadding: EdgeInsets.zero, + title: + Text(AppLocalizations.of(context)!.strictTranslate("Language")), + trailing: TextButton( + key: const Key('LanguageSelector'), + onPressed: () { + navigationService.pushReplacementScreen( + '/selectLang', + arguments: '0', + ); + }, + child: Text(userLanguage.langName), + ), + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_lang_switch/widgets_lang_switch-library.md b/talawa-mobile-docs/widgets_lang_switch/widgets_lang_switch-library.md new file mode 100644 index 0000000000..d092748098 --- /dev/null +++ b/talawa-mobile-docs/widgets_lang_switch/widgets_lang_switch-library.md @@ -0,0 +1,38 @@ + + + + +# lang_switch library + + + + + + + + + + + +## Classes + +##### [LanguageTile](../widgets_lang_switch/LanguageTile-class.md) + + + +This widget enables language switch for "internationalizing our app". + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md new file mode 100644 index 0000000000..10202832ba --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile-class.md @@ -0,0 +1,219 @@ + + + +# MemberNameTile class + + + + + + + + + +

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.

+ + + +**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) +- MemberNameTile + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [onDelete](../widgets_member_name_tile/MemberNameTile/onDelete.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [userImage](../widgets_member_name_tile/MemberNameTile/userImage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html)? + + + + +_final_ + + + +##### [userName](../widgets_member_name_tile/MemberNameTile/userName.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md new file mode 100644 index 0000000000..a2ae5471c9 --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/MemberNameTile.md @@ -0,0 +1,34 @@ + + + +# MemberNameTile constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const MemberNameTile({ + Key? key, + required this.userName, + this.userImage, + required this.onDelete, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md new file mode 100644 index 0000000000..2a1b65b432 --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/build.md @@ -0,0 +1,119 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Padding( + padding: const EdgeInsets.only(top: 10, right: 5), + child: Container( + width: SizeConfig.screenWidth! * (0.3 + userName.length / 50), + height: SizeConfig.screenHeight! * 0.04, + decoration: BoxDecoration( + borderRadius: BorderRadius.circular(SizeConfig.screenHeight! * 0.02), + color: Theme.of(context).colorScheme.primaryContainer, + ), + child: Row( + mainAxisAlignment: MainAxisAlignment.spaceBetween, + crossAxisAlignment: CrossAxisAlignment.center, + children: [ + // 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. + : CircleAvatar( + radius: SizeConfig.screenHeight! * 0.0201, + backgroundColor: Theme.of(context).colorScheme.secondary, + child: Text( + userName.substring(0, 1).toUpperCase(), + style: const TextStyle(color: Colors.white), + ), + ), + // The name of the member in text form. + Padding( + padding: const EdgeInsets.only(left: 5), + child: Text( + userName, + ), + ), + IconButton( + padding: EdgeInsets.zero, + onPressed: () => onDelete(), + icon: const Icon( + Icons.cancel_rounded, + color: Color(0xff524F4F), + size: 19, + ), + ) + ], + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md new file mode 100644 index 0000000000..043ff31feb --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/onDelete.md @@ -0,0 +1,32 @@ + + + +# onDelete property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) onDelete + +_final_ + + + + + + +## Implementation + +```dart +final Function onDelete; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md new file mode 100644 index 0000000000..a26568fc33 --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userImage.md @@ -0,0 +1,32 @@ + + + +# userImage property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html)? userImage + +_final_ + + + + + + +## Implementation + +```dart +final String? userImage; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md new file mode 100644 index 0000000000..196794fd63 --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/MemberNameTile/userName.md @@ -0,0 +1,32 @@ + + + +# userName property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) userName + +_final_ + + + + + + +## Implementation + +```dart +final String userName; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_member_name_tile/widgets_member_name_tile-library.md b/talawa-mobile-docs/widgets_member_name_tile/widgets_member_name_tile-library.md new file mode 100644 index 0000000000..a2d0955cb9 --- /dev/null +++ b/talawa-mobile-docs/widgets_member_name_tile/widgets_member_name_tile-library.md @@ -0,0 +1,41 @@ + + + + +# member_name_tile library + + + + + + + + + + + +## Classes + +##### [MemberNameTile](../widgets_member_name_tile/MemberNameTile-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md b/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md new file mode 100644 index 0000000000..11404fa293 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_list/OrganizationList-class.md @@ -0,0 +1,200 @@ + + + +# OrganizationList class + + + + + + + + + +

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) +- OrganizationList + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [model](../widgets_organization_list/OrganizationList/model.md) → [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) + + + +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) + + + +A representation of the runtime type of the object. +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md b/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md new file mode 100644 index 0000000000..d697ef2845 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_list/OrganizationList/OrganizationList.md @@ -0,0 +1,29 @@ + + + +# OrganizationList constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const OrganizationList({required this.model, Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md b/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md new file mode 100644 index 0000000000..b4c96e9632 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_list/OrganizationList/build.md @@ -0,0 +1,185 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + final navigationServiceLocal = locator(); + model.organizations = []; + int noOfRefetch = 0; + return GraphQLProvider( + 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! + '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) { + final isException = databaseFunctions.encounteredExceptionOrError( + result.exception!, + showSnackBar: noOfRefetch == 0, + ); + if (isException != null) { + if (isException) { + refetch!(); + noOfRefetch++; + } else { + refetch!(); + noOfRefetch++; + } + } + } 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) { + 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. + child: ListView.separated( + controller: model.allOrgController, + padding: EdgeInsets.zero, + shrinkWrap: true, + 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! + return ListTile( + title: Center( + child: CupertinoActivityIndicator( + radius: SizeConfig.screenWidth! * 0.065, + ), + ), + ); + } + // 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) { + model.fetchMoreHelper( + fetchMore!, + model.organizations, + ); + } + }, + child: CustomListTile( + index: index, + type: TileType.org, + orgInfo: model.organizations[index], + onTapOrgInfo: (item) => model.selectOrg(item), + key: Key('OrgSelItem$index'), + ), + ); + } + // 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), + key: Key('OrgSelItem$index'), + ); + }, + separatorBuilder: (BuildContext context, int index) { + return Container(); + }, + ), + ); + } + return Container(); + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md b/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md new file mode 100644 index 0000000000..d08ac7e696 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_list/OrganizationList/model.md @@ -0,0 +1,33 @@ + + + +# model property + + + + + + + +[SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model + +_final_ + + + +

model is a type of SelectOrganizationViewModel which provides methods to handle the data for this component.

+ + + +## Implementation + +```dart +final SelectOrganizationViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_list/widgets_organization_list-library.md b/talawa-mobile-docs/widgets_organization_list/widgets_organization_list-library.md new file mode 100644 index 0000000000..dfd618cfdf --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_list/widgets_organization_list-library.md @@ -0,0 +1,38 @@ + + + + +# organization_list library + + + + + + + + + + + +## Classes + +##### [OrganizationList](../widgets_organization_list/OrganizationList-class.md) + + + +This class returns the OrganizationList widget. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md new file mode 100644 index 0000000000..c7def0d5c5 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList-class.md @@ -0,0 +1,199 @@ + + + +# OrganizationSearchList class + + + + + + + + + +

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) +- OrganizationSearchList + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [model](../widgets_organization_search_list/OrganizationSearchList/model.md) → [SelectOrganizationViewModel](../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md new file mode 100644 index 0000000000..96e9f385d6 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/OrganizationSearchList.md @@ -0,0 +1,30 @@ + + + +# OrganizationSearchList constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const OrganizationSearchList({required this.model, Key? key}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md new file mode 100644 index 0000000000..9ce4605352 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/build.md @@ -0,0 +1,182 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return GraphQLProvider( + client: ValueNotifier(graphqlConfig.authClient()), + child: Query( + options: QueryOptions( + document: gql(Queries().fetchJoinInOrgByName), + variables: { + 'nameStartsWith': model.searchController.text, + // 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) { + final isException = databaseFunctions.encounteredExceptionOrError( + result.exception!, + showSnackBar: false, + ); + if (isException!) { + refetch!(); + } else { + refetch!(); + } + } 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 Scrollbar( + thumbVisibility: true, + interactive: true, + controller: model.controller, + // Listview is a scrollable list of widgets arranged linearly. + child: ListView.separated( + controller: model.controller, + padding: EdgeInsets.zero, + shrinkWrap: true, + 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! + return ListTile( + title: Center( + child: CupertinoActivityIndicator( + radius: SizeConfig.screenWidth! * 0.065, + ), + ), + ); + } + // 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) { + 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), + key: Key('OrgSelItem$index'), + ), + ); + } + // 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), + key: Key('OrgSelItem$index'), + ); + }, + separatorBuilder: (BuildContext context, int index) { + return Padding( + padding: EdgeInsets.only( + left: SizeConfig.screenWidth! * 0.2, + right: 12, + ), + child: const Divider( + color: Color(0xFFE5E5E5), + thickness: 0.5, + ), + ); + }, + ), + ); + } + return Container(); + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md new file mode 100644 index 0000000000..5906910b45 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_search_list/OrganizationSearchList/model.md @@ -0,0 +1,32 @@ + + + +# model property + + + + + + + +[SelectOrganizationViewModel](../../view_model_pre_auth_view_models_select_organization_view_model/SelectOrganizationViewModel-class.md) model + +_final_ + + + + + + +## Implementation + +```dart +final SelectOrganizationViewModel model; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_organization_search_list/widgets_organization_search_list-library.md b/talawa-mobile-docs/widgets_organization_search_list/widgets_organization_search_list-library.md new file mode 100644 index 0000000000..bfd5d11593 --- /dev/null +++ b/talawa-mobile-docs/widgets_organization_search_list/widgets_organization_search_list-library.md @@ -0,0 +1,39 @@ + + + + +# organization_search_list library + + + + + + + + + + + +## Classes + +##### [OrganizationSearchList](../widgets_organization_search_list/OrganizationSearchList-class.md) + + + +OrganizationSearchList class return a widget that shows all +the matching organizations searched on the search bar. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md new file mode 100644 index 0000000000..cf25bd3816 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller-class.md @@ -0,0 +1,209 @@ + + + +# CustomCarouselScroller class + + + + + + + + + + + + +**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) +- CustomCarouselScroller + + + + + + +**Annotations** + +- @[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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [navigateToIndividualPostPage](../widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_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)> + + + + +_final_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md)() [CustomCarouselScrollerState](../widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md) + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md new file mode 100644 index 0000000000..5cb9c6ebd6 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/CustomCarouselScroller.md @@ -0,0 +1,33 @@ + + + +# CustomCarouselScroller constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CustomCarouselScroller({ + Key? key, + required this.pinnedPosts, + required this.navigateToIndividualPostPage, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md new file mode 100644 index 0000000000..581e73be45 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +[CustomCarouselScrollerState](../../widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md) createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +CustomCarouselScrollerState createState() => CustomCarouselScrollerState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md new file mode 100644 index 0000000000..362a98fd37 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/navigateToIndividualPostPage.md @@ -0,0 +1,32 @@ + + + +# navigateToIndividualPostPage property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage + +_final_ + + + + + + +## Implementation + +```dart +final Function navigateToIndividualPostPage; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md new file mode 100644 index 0000000000..4071846ea2 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScroller/pinnedPosts.md @@ -0,0 +1,32 @@ + + + +# pinnedPosts property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts + +_final_ + + + + + + +## Implementation + +```dart +final List pinnedPosts; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md new file mode 100644 index 0000000000..3af904b518 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md @@ -0,0 +1,268 @@ + + + +# CustomCarouselScrollerState class + + + + + + + + + +

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)> +- CustomCarouselScrollerState + + + + +**Available Extensions** + +- [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) + + +## Constructors + +[CustomCarouselScrollerState](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/CustomCarouselScrollerState.md) () + + + + +## Properties + +##### [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_ + + + +##### [controller](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md) → [PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [pindex](../widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md) ↔ [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [widget](https://api.flutter.dev/flutter/widgets/State/widget.html) → [CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md) + + + +The current configuration. +_read-onlyinherited_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [deactivate](https://api.flutter.dev/flutter/widgets/State/deactivate.html)() void + + + +Called when this object is removed from the tree. +_inherited_ + + + +##### [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_ + + + +##### [didChangeDependencies](https://api.flutter.dev/flutter/widgets/State/didChangeDependencies.html)() void + + + +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 + + + +Called whenever the widget configuration changes. +_inherited_ + + + +##### [dispose](https://api.flutter.dev/flutter/widgets/State/dispose.html)() void + + + +Called when this object is removed from the tree permanently. +_inherited_ + + + +##### [initState](https://api.flutter.dev/flutter/widgets/State/initState.html)() void + + + +Called when this object is inserted into the tree. +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/CustomCarouselScrollerState.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/CustomCarouselScrollerState.md new file mode 100644 index 0000000000..c6b1a3deb5 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/CustomCarouselScrollerState.md @@ -0,0 +1,24 @@ + + + +# CustomCarouselScrollerState constructor + + + + + + + +CustomCarouselScrollerState() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md new file mode 100644 index 0000000000..e57b057bd2 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/build.md @@ -0,0 +1,208 @@ + + + +# build method + + + + + + + +- @[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) + +_override_ + + + +

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

+

The framework calls this method in a number of different situations. For +example:

+ +

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 +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 +that are configured with information from this widget's constructor, the +given BuildContext, and the internal state of this State object.

+

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. The +BuildContext argument is always the same as the context property of +this State object and will remain the same for the lifetime of this +object. The BuildContext argument is provided redundantly here so that +this method matches the signature for a WidgetBuilder.

+

Design discussion

+

Why is the build method on State, and not StatefulWidget?

+

Putting a Widget build(BuildContext context) method on State rather +than putting a Widget build(BuildContext context, State state) method +on StatefulWidget gives developers more flexibility when subclassing +StatefulWidget.

+

For example, AnimatedWidget is a subclass of StatefulWidget that +introduces an abstract Widget build(BuildContext context) method for its +subclasses to implement. If StatefulWidget already had a build method +that took a State argument, AnimatedWidget would be forced to provide +its State object to subclasses even though its State object is an +internal implementation detail of AnimatedWidget.

+

Conceptually, StatelessWidget could also be implemented as a subclass of +StatefulWidget in a similar manner. If the build method were on +StatefulWidget rather than State, that would not be possible anymore.

+

Putting the build function on State rather than StatefulWidget also +helps avoid a category of bugs related to closures implicitly capturing +this. If you defined a closure in a build function on a +StatefulWidget, that closure would implicitly capture this, which is +the current widget instance, and would have the (immutable) fields of that +instance in scope:

+
// (this is not valid Flutter code)
+class MyButton extends StatefulWidgetX {
+  MyButton({super.key, required this.color});
+
+  final Color color;
+
+  @override
+  Widget build(BuildContext context, State state) {
+    return SpecialWidget(
+      handler: () { print('color: $color'); },
+    );
+  }
+}
+
+

For example, suppose the parent builds MyButton with color being blue, +the $color in the print function refers to blue, as expected. Now, +suppose the parent rebuilds MyButton with green. The closure created by +the first build still implicitly refers to the original widget and the +$color still prints blue even through the widget has been updated to +green; should that closure outlive its widget, it would print outdated +information.

+

In contrast, with the build function on the State object, closures +created during build implicitly capture the State instance instead of +the widget instance:

+
class MyButton extends StatefulWidget {
+  const MyButton({super.key, this.color = Colors.teal});
+
+  final Color color;
+  // ...
+}
+
+class MyButtonState extends State<MyButton> {
+  // ...
+  @override
+  Widget build(BuildContext context) {
+    return SpecialWidget(
+      handler: () { print('color: ${widget.color}'); },
+    );
+  }
+}
+
+

Now when the parent rebuilds MyButton with green, the closure created by +the first build still refers to State object, which is preserved across +rebuilds, but the framework has updated that State object's widget +property to refer to the new MyButton instance and ${widget.color} +prints green, as expected.

+

See also:

+
    +
  • StatefulWidget, which contains the discussion on performance considerations.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + // Stack is a widget that positions its children relative to the edges of its box. + return Stack( + children: [ + Padding( + padding: const EdgeInsets.symmetric(horizontal: 8.0), + child: Column( + crossAxisAlignment: CrossAxisAlignment.center, + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.end, + children: [ + ListTile( + leading: const CircleAvatar( + radius: 15.0, + backgroundColor: Color(0xff737373), + ), + title: Text( + "${widget.pinnedPosts[pindex].creator!.firstName} ${widget.pinnedPosts[pindex].creator!.lastName}", + ), + ), + Padding( + padding: const EdgeInsets.symmetric(horizontal: 16.0), + child: Text( + widget.pinnedPosts[pindex].description!.length > 90 + ? "${widget.pinnedPosts[pindex].description!.substring(0, 90)}..." + : widget.pinnedPosts[pindex].description!, + style: Theme.of(context) + .textTheme + .bodyLarge! + .copyWith(color: const Color(0xFF737373)), + ), + ), + Padding( + padding: const EdgeInsets.symmetric( + horizontal: 16.0, + vertical: 10.0, + ), + child: Row( + children: [ + for (int i = 0; i < 4; i++) + Expanded( + child: Padding( + padding: const EdgeInsets.symmetric(horizontal: 5.0), + child: Divider( + thickness: 3.0, + color: pindex == i + ? Theme.of(context).colorScheme.primary + : Colors.grey, + ), + ), + ) + ], + ), + ) + ], + ), + ), + PageView( + scrollDirection: Axis.horizontal, + controller: controller, + onPageChanged: (index) { + setState(() { + pindex = index; + }); + }, + children: List.generate( + widget.pinnedPosts.length, + (index) => Container(), + ), + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md new file mode 100644 index 0000000000..1ba09ce41a --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/controller.md @@ -0,0 +1,32 @@ + + + +# controller property + + + + + + + +[PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) controller + +_final_ + + + + + + +## Implementation + +```dart +final PageController controller = PageController(initialPage: 0); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md new file mode 100644 index 0000000000..e609f0c282 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/CustomCarouselScrollerState/pindex.md @@ -0,0 +1,32 @@ + + + +# pindex property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) pindex + +_read / write_ + + + + + + +## Implementation + +```dart +int pindex = 0; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md new file mode 100644 index 0000000000..fc37c18915 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel-class.md @@ -0,0 +1,218 @@ + + + +# PinnedPostCarousel class + + + + + + + + + +

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.

+ + + +**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) +- PinnedPostCarousel + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [navigateToIndividualPostPage](../widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_final_ + + + +##### [navigateToPinnedPostPage](../widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md) → [Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) + + + + +_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)> + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md new file mode 100644 index 0000000000..f2cc5392f2 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/PinnedPostCarousel.md @@ -0,0 +1,34 @@ + + + +# PinnedPostCarousel constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const PinnedPostCarousel({ + Key? key, + required this.pinnedPosts, + required this.navigateToPinnedPostPage, + required this.navigateToIndividualPostPage, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md new file mode 100644 index 0000000000..8010d7a738 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/build.md @@ -0,0 +1,119 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Column( + children: [ + Container( + height: 220, + color: + Theme.of(context).colorScheme.primaryContainer.withOpacity(0.5), + child: CustomCarouselScroller( + pinnedPosts: pinnedPosts, + key: const Key('Carousel'), + 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. + GestureDetector( + onTap: () => navigateToPinnedPostPage(), + child: Container( + height: 50, + width: SizeConfig.screenWidth, + padding: const EdgeInsets.symmetric(horizontal: 16.0), + color: Theme.of(context).colorScheme.primaryContainer, + child: Row( + children: [ + Expanded( + flex: 1, + child: Padding( + padding: const EdgeInsets.only(right: 8.0), + child: Icon( + Icons.article, + color: Theme.of(context).colorScheme.secondary, + ), + ), + ), + Expanded( + flex: 8, + child: Text( + AppLocalizations.of(context)! + .strictTranslate("See all Pinned news"), + style: Theme.of(context).textTheme.titleLarge, + ), + ), + const Expanded(flex: 1, child: Icon(Icons.arrow_forward_ios)) + ], + ), + ), + ) + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md new file mode 100644 index 0000000000..362a98fd37 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToIndividualPostPage.md @@ -0,0 +1,32 @@ + + + +# navigateToIndividualPostPage property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToIndividualPostPage + +_final_ + + + + + + +## Implementation + +```dart +final Function navigateToIndividualPostPage; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md new file mode 100644 index 0000000000..9fbe8e2758 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/navigateToPinnedPostPage.md @@ -0,0 +1,32 @@ + + + +# navigateToPinnedPostPage property + + + + + + + +[Function](https://api.flutter.dev/flutter/dart-core/Function-class.html) navigateToPinnedPostPage + +_final_ + + + + + + +## Implementation + +```dart +final Function navigateToPinnedPostPage; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md new file mode 100644 index 0000000000..4071846ea2 --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/PinnedPostCarousel/pinnedPosts.md @@ -0,0 +1,32 @@ + + + +# pinnedPosts property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> pinnedPosts + +_final_ + + + + + + +## Implementation + +```dart +final List pinnedPosts; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md b/talawa-mobile-docs/widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md new file mode 100644 index 0000000000..a40cca69eb --- /dev/null +++ b/talawa-mobile-docs/widgets_pinned_carousel_widget/widgets_pinned_carousel_widget-library.md @@ -0,0 +1,55 @@ + + + + +# pinned_carousel_widget library + + + + + + + + + + + +## Classes + +##### [CustomCarouselScroller](../widgets_pinned_carousel_widget/CustomCarouselScroller-class.md) + + + + + + +##### [CustomCarouselScrollerState](../widgets_pinned_carousel_widget/CustomCarouselScrollerState-class.md) + + + +CustomCarouselScrollerState class return a widget that is +used to generate slider for pinned post on the top of the Home Screen. + + +##### [PinnedPostCarousel](../widgets_pinned_carousel_widget/PinnedPostCarousel-class.md) + + + +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. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md new file mode 100644 index 0000000000..270bf50da5 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget-class.md @@ -0,0 +1,201 @@ + + + +# DescriptionTextWidget class + + + + + + + + + +

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).

+ + + +**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) +- DescriptionTextWidget + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [text](../widgets_post_detailed_page/DescriptionTextWidget/text.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../widgets_post_detailed_page/DescriptionTextWidget/createState.md)() _DescriptionTextWidgetState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md new file mode 100644 index 0000000000..9e9f4749e7 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/DescriptionTextWidget.md @@ -0,0 +1,29 @@ + + + +# DescriptionTextWidget constructor + + + + + + +const +DescriptionTextWidget({required [String](https://api.flutter.dev/flutter/dart-core/String-class.html) text}) + + + + + +## Implementation + +```dart +const DescriptionTextWidget({required this.text}); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md new file mode 100644 index 0000000000..334915de6f --- /dev/null +++ b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_DescriptionTextWidgetState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_DescriptionTextWidgetState createState() => _DescriptionTextWidgetState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/text.md b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/text.md new file mode 100644 index 0000000000..a7f6f7d63a --- /dev/null +++ b/talawa-mobile-docs/widgets_post_detailed_page/DescriptionTextWidget/text.md @@ -0,0 +1,32 @@ + + + +# text property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) text + +_final_ + + + + + + +## Implementation + +```dart +final String text; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_detailed_page/widgets_post_detailed_page-library.md b/talawa-mobile-docs/widgets_post_detailed_page/widgets_post_detailed_page-library.md new file mode 100644 index 0000000000..62d50933da --- /dev/null +++ b/talawa-mobile-docs/widgets_post_detailed_page/widgets_post_detailed_page-library.md @@ -0,0 +1,41 @@ + + + + +# post_detailed_page library + + + + + + + + + + + +## Classes + +##### [DescriptionTextWidget](../widgets_post_detailed_page/DescriptionTextWidget-class.md) + + + +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). + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md new file mode 100644 index 0000000000..45a69dc1ca --- /dev/null +++ b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget-class.md @@ -0,0 +1,207 @@ + + + +# PostListWidget class + + + + + + + + + +

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) +- PostListWidget + + + + + + + + +## 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))?}) + + _const_ + + +## Properties + +##### [function](../widgets_post_list_widget/PostListWidget/function.md) → (dynamic Function([Post](../models_post_post_model/Post-class.md))?) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md new file mode 100644 index 0000000000..de06239773 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/PostListWidget.md @@ -0,0 +1,33 @@ + + + +# PostListWidget constructor + + + + + + +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))?}) + + + + + +## Implementation + +```dart +const PostListWidget({ + Key? key, + required this.posts, + this.function, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md new file mode 100644 index 0000000000..9bc187f9a3 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/build.md @@ -0,0 +1,93 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return ListView.builder( + scrollDirection: Axis.vertical, + physics: const NeverScrollableScrollPhysics(), + shrinkWrap: true, + itemCount: posts.length, + itemBuilder: (BuildContext context, int index) { + return Column( + children: [ + NewsPost( + post: posts[index], + function: function, + ), + const Padding( + padding: EdgeInsets.symmetric(vertical: 10.0), + child: Divider( + height: 8, + thickness: 8, + ), + ) + ], + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md new file mode 100644 index 0000000000..4e87ea5a33 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/function.md @@ -0,0 +1,32 @@ + + + +# function property + + + + + + + +(dynamic Function([Post](../../models_post_post_model/Post-class.md))?) function + +_final_ + + + + + + +## Implementation + +```dart +final Function(Post)? function; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md new file mode 100644 index 0000000000..9a3b8ad653 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_list_widget/PostListWidget/posts.md @@ -0,0 +1,32 @@ + + + +# posts property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Post](../../models_post_post_model/Post-class.md)> posts + +_final_ + + + + + + +## Implementation + +```dart +final List posts; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_list_widget/widgets_post_list_widget-library.md b/talawa-mobile-docs/widgets_post_list_widget/widgets_post_list_widget-library.md new file mode 100644 index 0000000000..4a511f63be --- /dev/null +++ b/talawa-mobile-docs/widgets_post_list_widget/widgets_post_list_widget-library.md @@ -0,0 +1,38 @@ + + + + +# post_list_widget library + + + + + + + + + + + +## Classes + +##### [PostListWidget](../widgets_post_list_widget/PostListWidget-class.md) + + + +This class receives a List of all the Post widgets and returns a ListView. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md b/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md new file mode 100644 index 0000000000..181f9935bd --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/NewsPost-class.md @@ -0,0 +1,206 @@ + + + +# NewsPost class + + + + + + + + + + + + +**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) +- NewsPost + + + + + + + + +## 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))?}) + + _const_ + + +## Properties + +##### [function](../widgets_post_widget/NewsPost/function.md) → (dynamic Function([Post](../models_post_post_model/Post-class.md))?) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [post](../widgets_post_widget/NewsPost/post.md) → [Post](../models_post_post_model/Post-class.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md b/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md new file mode 100644 index 0000000000..4f831c08be --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/NewsPost/NewsPost.md @@ -0,0 +1,33 @@ + + + +# NewsPost constructor + + + + + + +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))?}) + + + + + +## Implementation + +```dart +const NewsPost({ + Key? key, + required this.post, + this.function, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md b/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md new file mode 100644 index 0000000000..3e6ebf4699 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/NewsPost/build.md @@ -0,0 +1,164 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + // const PinnedPostCarousel(), + ListTile( + leading: CustomAvatar( + isImageNull: post.creator!.image == null, + firstAlphabet: + post.creator!.firstName!.substring(0, 1).toUpperCase(), + imageUrl: post.creator!.image, + fontSize: 24, + ), + title: Text( + "${post.creator!.firstName} ${post.creator!.lastName}", + style: const TextStyle(fontSize: 20, fontWeight: FontWeight.w400), + ), + subtitle: Text(post.getPostCreatedDuration()), + ), + DescriptionTextWidget(text: post.description!), + Container( + height: 400, + color: + Theme.of(context).colorScheme.primaryContainer.withOpacity(0.5), + child: PostContainer(id: post.sId), + ), + BaseView( + onModelReady: (model) { + model.initialize(post.likedBy ?? [], post.sId); + }, + builder: (context, model, child) => Column( + children: [ + Padding( + padding: + const EdgeInsets.symmetric(horizontal: 16, vertical: 10), + child: Row( + mainAxisAlignment: MainAxisAlignment.spaceBetween, + children: [ + GestureDetector( + onTap: () => function != null ? function!(post) : {}, + child: Text( + "${model.likedBy.length} ${AppLocalizations.of(context)!.strictTranslate("Likes")}", + style: const TextStyle( + fontFamily: 'open-sans', + fontWeight: FontWeight.w800, + ), + ), + ), + GestureDetector( + onTap: () => function != null ? function!(post) : {}, + child: Text( + "${post.comments!.length} ${AppLocalizations.of(context)!.strictTranslate("comments")}", + ), + ) + ], + ), + ), + const Padding( + padding: EdgeInsets.symmetric(horizontal: 16.0), + child: Divider(), + ), + Padding( + padding: + const EdgeInsets.symmetric(horizontal: 16, vertical: 5), + child: Row( + children: [ + GestureDetector( + onTap: () { + model.toggleIsLiked(); + }, + child: Icon( + Icons.thumb_up, + color: model.isLiked + ? Theme.of(context).colorScheme.secondary + : const Color(0xff737373), + ), + ), + GestureDetector( + onTap: () => function != null ? function!(post) : {}, + child: const Padding( + padding: EdgeInsets.only(left: 18.0), + child: Icon( + Icons.comment, + color: Color(0xff737373), + ), + ), + ), + ], + ), + ), + ], + ), + ), + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md b/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md new file mode 100644 index 0000000000..4e87ea5a33 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/NewsPost/function.md @@ -0,0 +1,32 @@ + + + +# function property + + + + + + + +(dynamic Function([Post](../../models_post_post_model/Post-class.md))?) function + +_final_ + + + + + + +## Implementation + +```dart +final Function(Post)? function; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md b/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md new file mode 100644 index 0000000000..e986becbc0 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/NewsPost/post.md @@ -0,0 +1,32 @@ + + + +# post property + + + + + + + +[Post](../../models_post_post_model/Post-class.md) post + +_final_ + + + + + + +## Implementation + +```dart +final Post post; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md b/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md new file mode 100644 index 0000000000..5ae9ca9e60 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainer-class.md @@ -0,0 +1,197 @@ + + + +# PostContainer class + + + + + + + + + + + + +**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) +- PostContainer + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [id](../widgets_post_widget/PostContainer/id.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../widgets_post_widget/PostContainer/createState.md)() [PostContainerState](../widgets_post_widget/PostContainerState-class.md) + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md b/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md new file mode 100644 index 0000000000..dc9ee62f13 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainer/PostContainer.md @@ -0,0 +1,32 @@ + + + +# PostContainer constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const PostContainer({ + required this.id, + Key? key, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md b/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md new file mode 100644 index 0000000000..85cd7e218d --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainer/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +[PostContainerState](../../widgets_post_widget/PostContainerState-class.md) createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +PostContainerState createState() => PostContainerState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainer/id.md b/talawa-mobile-docs/widgets_post_widget/PostContainer/id.md new file mode 100644 index 0000000000..672a052c2a --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainer/id.md @@ -0,0 +1,32 @@ + + + +# id property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) id + +_final_ + + + + + + +## Implementation + +```dart +final String id; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md new file mode 100644 index 0000000000..e8506d7a1b --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState-class.md @@ -0,0 +1,281 @@ + + + +# PostContainerState class + + + + + + + + + + + + +**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)> +- PostContainerState + + + + +**Available Extensions** + +- [StateExt](https://pub.dev/documentation/tutorial_coach_mark/1.2.9/tutorial_coach_mark/StateExt.html) + + + + +## Constructors + +[PostContainerState](../widgets_post_widget/PostContainerState/PostContainerState.md) () + + + + +## Properties + +##### [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_ + + + +##### [controller](../widgets_post_widget/PostContainerState/controller.md) → [PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [inView](../widgets_post_widget/PostContainerState/inView.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [pindex](../widgets_post_widget/PostContainerState/pindex.md) ↔ [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + + +_read / write_ + + + +##### [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_ + + + +##### [startedPlaying](../widgets_post_widget/PostContainerState/startedPlaying.md) ↔ [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_read / write_ + + + +##### [widget](https://api.flutter.dev/flutter/widgets/State/widget.html) → [PostContainer](../widgets_post_widget/PostContainer-class.md) + + + +The current configuration. +_read-onlyinherited_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [deactivate](https://api.flutter.dev/flutter/widgets/State/deactivate.html)() void + + + +Called when this object is removed from the tree. +_inherited_ + + + +##### [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_ + + + +##### [didChangeDependencies](https://api.flutter.dev/flutter/widgets/State/didChangeDependencies.html)() void + + + +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 + + + +Called whenever the widget configuration changes. +_inherited_ + + + +##### [dispose](../widgets_post_widget/PostContainerState/dispose.md)() void + + + +Called when this object is removed from the tree permanently. +_override_ + + + +##### [initState](../widgets_post_widget/PostContainerState/initState.md)() void + + + +Called when this object is inserted into the tree. +_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 + + + +Invoked when a non-existent method or property is accessed. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/PostContainerState.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/PostContainerState.md new file mode 100644 index 0000000000..14ae45f061 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/PostContainerState.md @@ -0,0 +1,24 @@ + + + +# PostContainerState constructor + + + + + + + +PostContainerState() + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/build.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/build.md new file mode 100644 index 0000000000..41c5dc686b --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/build.md @@ -0,0 +1,207 @@ + + + +# build method + + + + + + + +- @[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) + +_override_ + + + +

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

+

The framework calls this method in a number of different situations. For +example:

+ +

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 +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 +that are configured with information from this widget's constructor, the +given BuildContext, and the internal state of this State object.

+

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. The +BuildContext argument is always the same as the context property of +this State object and will remain the same for the lifetime of this +object. The BuildContext argument is provided redundantly here so that +this method matches the signature for a WidgetBuilder.

+

Design discussion

+

Why is the build method on State, and not StatefulWidget?

+

Putting a Widget build(BuildContext context) method on State rather +than putting a Widget build(BuildContext context, State state) method +on StatefulWidget gives developers more flexibility when subclassing +StatefulWidget.

+

For example, AnimatedWidget is a subclass of StatefulWidget that +introduces an abstract Widget build(BuildContext context) method for its +subclasses to implement. If StatefulWidget already had a build method +that took a State argument, AnimatedWidget would be forced to provide +its State object to subclasses even though its State object is an +internal implementation detail of AnimatedWidget.

+

Conceptually, StatelessWidget could also be implemented as a subclass of +StatefulWidget in a similar manner. If the build method were on +StatefulWidget rather than State, that would not be possible anymore.

+

Putting the build function on State rather than StatefulWidget also +helps avoid a category of bugs related to closures implicitly capturing +this. If you defined a closure in a build function on a +StatefulWidget, that closure would implicitly capture this, which is +the current widget instance, and would have the (immutable) fields of that +instance in scope:

+
// (this is not valid Flutter code)
+class MyButton extends StatefulWidgetX {
+  MyButton({super.key, required this.color});
+
+  final Color color;
+
+  @override
+  Widget build(BuildContext context, State state) {
+    return SpecialWidget(
+      handler: () { print('color: $color'); },
+    );
+  }
+}
+
+

For example, suppose the parent builds MyButton with color being blue, +the $color in the print function refers to blue, as expected. Now, +suppose the parent rebuilds MyButton with green. The closure created by +the first build still implicitly refers to the original widget and the +$color still prints blue even through the widget has been updated to +green; should that closure outlive its widget, it would print outdated +information.

+

In contrast, with the build function on the State object, closures +created during build implicitly capture the State instance instead of +the widget instance:

+
class MyButton extends StatefulWidget {
+  const MyButton({super.key, this.color = Colors.teal});
+
+  final Color color;
+  // ...
+}
+
+class MyButtonState extends State<MyButton> {
+  // ...
+  @override
+  Widget build(BuildContext context) {
+    return SpecialWidget(
+      handler: () { print('color: ${widget.color}'); },
+    );
+  }
+}
+
+

Now when the parent rebuilds MyButton with green, the closure created by +the first build still refers to State object, which is preserved across +rebuilds, but the framework has updated that State object's widget +property to refer to the new MyButton instance and ${widget.color} +prints green, as expected.

+

See also:

+
    +
  • StatefulWidget, which contains the discussion on performance considerations.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return VisibilityDetector( + key: Key(widget.id), + onVisibilityChanged: (info) { + info.visibleFraction > 0.5 ? inView = true : inView = false; + if (mounted) setState(() {}); + }, + child: Stack( + children: [ + PageView( + scrollDirection: Axis.horizontal, + controller: controller, + onPageChanged: (index) { + setState(() { + pindex = index; + inView = pindex == 0; + }); + }, + children: List.generate( + 4, + (index) => index == 0 + ? Center( + child: VideoWidget( + url: + 'https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4', + play: inView, + ), + ) + : const Image( + image: NetworkImage( + 'https://flutter.github.io/assets-for-api-docs/assets/widgets/owl.jpg', + ), + ), + ), + ), + Padding( + padding: const EdgeInsets.symmetric(horizontal: 8.0), + child: Column( + crossAxisAlignment: CrossAxisAlignment.center, + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.end, + children: [ + Padding( + padding: const EdgeInsets.symmetric( + horizontal: 100.0, + vertical: 10.0, + ), + child: Row( + children: [ + for (int i = 0; i < 4; i++) + Expanded( + child: Padding( + padding: + const EdgeInsets.symmetric(horizontal: 5.0), + child: Divider( + thickness: 3.0, + color: pindex == i + ? Theme.of(context).colorScheme.primary + : Colors.grey, + ), + ), + ) + ], + ), + ) + ], + ), + ), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md new file mode 100644 index 0000000000..1ba09ce41a --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/controller.md @@ -0,0 +1,32 @@ + + + +# controller property + + + + + + + +[PageController](https://api.flutter.dev/flutter/widgets/PageController-class.html) controller + +_final_ + + + + + + +## Implementation + +```dart +final PageController controller = PageController(initialPage: 0); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md new file mode 100644 index 0000000000..74c5469f9b --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/dispose.md @@ -0,0 +1,65 @@ + + + +# dispose method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void dispose +() + +_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 +other object to which one can subscribe to receive notifications, then +be sure to subscribe and unsubscribe properly in initState, +didUpdateWidget, and dispose:

+
    +
  • In initState, subscribe to the object.
  • +
  • In didUpdateWidget unsubscribe from the old object and subscribe +to the new one if the updated widget configuration requires +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:

+ + + + +## Implementation + +```dart +@override +void dispose() { + controller.dispose(); + super.dispose(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md new file mode 100644 index 0000000000..92c14bb973 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/inView.md @@ -0,0 +1,32 @@ + + + +# inView property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) inView + +_read / write_ + + + + + + +## Implementation + +```dart +bool inView = true; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md new file mode 100644 index 0000000000..7e00195161 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/initState.md @@ -0,0 +1,62 @@ + + + +# initState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +void initState +() + +_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 +other object to which one can subscribe to receive notifications, then +be sure to subscribe and unsubscribe properly in initState, +didUpdateWidget, and dispose:

+
    +
  • In initState, subscribe to the object.
  • +
  • In didUpdateWidget unsubscribe from the old object and subscribe +to the new one if the updated widget configuration requires +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().

+ + + +## Implementation + +```dart +@override +void initState() { + super.initState(); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md new file mode 100644 index 0000000000..e609f0c282 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/pindex.md @@ -0,0 +1,32 @@ + + + +# pindex property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) pindex + +_read / write_ + + + + + + +## Implementation + +```dart +int pindex = 0; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md b/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md new file mode 100644 index 0000000000..765d3d6af0 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/PostContainerState/startedPlaying.md @@ -0,0 +1,32 @@ + + + +# startedPlaying property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) startedPlaying + +_read / write_ + + + + + + +## Implementation + +```dart +bool startedPlaying = false; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_post_widget/widgets_post_widget-library.md b/talawa-mobile-docs/widgets_post_widget/widgets_post_widget-library.md new file mode 100644 index 0000000000..88746391b8 --- /dev/null +++ b/talawa-mobile-docs/widgets_post_widget/widgets_post_widget-library.md @@ -0,0 +1,52 @@ + + + + +# post_widget library + + + + + + + + + + + +## Classes + +##### [NewsPost](../widgets_post_widget/NewsPost-class.md) + + + + + + +##### [PostContainer](../widgets_post_widget/PostContainer-class.md) + + + + + + +##### [PostContainerState](../widgets_post_widget/PostContainerState-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md new file mode 100644 index 0000000000..f4dd829d24 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton-class.md @@ -0,0 +1,253 @@ + + + +# RaisedRoundedButton class + + + + + + + + + +

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) +- RaisedRoundedButton + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [backgroundColor](../widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md) → [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) + + + + +_final_ + + + +##### [buttonLabel](../widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [height](../widgets_raised_round_edge_button/RaisedRoundedButton/height.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_final_ + + + +##### [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_ + + + +##### [onTap](../widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md) → dynamic Function() + + + + +_final_ + + + +##### [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_ + + + +##### [showArrow](../widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [textColor](../widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md) → [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) + + + + +_final_ + + + +##### [width](../widgets_raised_round_edge_button/RaisedRoundedButton/width.md) → [double](https://api.flutter.dev/flutter/dart-core/double-class.html)? + + + + +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../widgets_raised_round_edge_button/RaisedRoundedButton/createState.md)() _RaisedRoundedButtonState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md new file mode 100644 index 0000000000..99d95d5c85 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/RaisedRoundedButton.md @@ -0,0 +1,38 @@ + + + +# RaisedRoundedButton constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const RaisedRoundedButton({ + required Key key, + required this.buttonLabel, + required this.backgroundColor, + required this.textColor, + required this.onTap, + this.height, + this.width, + this.showArrow = false, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md new file mode 100644 index 0000000000..07df8f9043 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/backgroundColor.md @@ -0,0 +1,32 @@ + + + +# backgroundColor property + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) backgroundColor + +_final_ + + + + + + +## Implementation + +```dart +final Color backgroundColor; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md new file mode 100644 index 0000000000..9dad55b192 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/buttonLabel.md @@ -0,0 +1,32 @@ + + + +# buttonLabel property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) buttonLabel + +_final_ + + + + + + +## Implementation + +```dart +final String buttonLabel; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md new file mode 100644 index 0000000000..1533476251 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_RaisedRoundedButtonState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_RaisedRoundedButtonState createState() => _RaisedRoundedButtonState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/height.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/height.md new file mode 100644 index 0000000000..3db9a95b5d --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/height.md @@ -0,0 +1,32 @@ + + + +# height property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? height + +_final_ + + + + + + +## Implementation + +```dart +final double? height; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md new file mode 100644 index 0000000000..71f15a9add --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/onTap.md @@ -0,0 +1,32 @@ + + + +# onTap property + + + + + + + +dynamic Function() onTap + +_final_ + + + + + + +## Implementation + +```dart +final Function() onTap; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md new file mode 100644 index 0000000000..989fd8683c --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/showArrow.md @@ -0,0 +1,32 @@ + + + +# showArrow property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showArrow + +_final_ + + + + + + +## Implementation + +```dart +final bool showArrow; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md new file mode 100644 index 0000000000..7c04e70516 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/textColor.md @@ -0,0 +1,32 @@ + + + +# textColor property + + + + + + + +[Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) textColor + +_final_ + + + + + + +## Implementation + +```dart +final Color textColor; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md new file mode 100644 index 0000000000..e35287c28d --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/RaisedRoundedButton/width.md @@ -0,0 +1,32 @@ + + + +# width property + + + + + + + +[double](https://api.flutter.dev/flutter/dart-core/double-class.html)? width + +_final_ + + + + + + +## Implementation + +```dart +final double? width; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_raised_round_edge_button/widgets_raised_round_edge_button-library.md b/talawa-mobile-docs/widgets_raised_round_edge_button/widgets_raised_round_edge_button-library.md new file mode 100644 index 0000000000..e0cb23ea26 --- /dev/null +++ b/talawa-mobile-docs/widgets_raised_round_edge_button/widgets_raised_round_edge_button-library.md @@ -0,0 +1,39 @@ + + + + +# raised_round_edge_button library + + + + + + + + + + + +## Classes + +##### [RaisedRoundedButton](../widgets_raised_round_edge_button/RaisedRoundedButton-class.md) + + + +This class returns a widget for a raised rounded button, +for example: login button in login screen. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md b/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md new file mode 100644 index 0000000000..c57b561fd6 --- /dev/null +++ b/talawa-mobile-docs/widgets_rich_text/CustomRichText-class.md @@ -0,0 +1,199 @@ + + + +# CustomRichText class + + + + + + + + + +

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) +- CustomRichText + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md b/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md new file mode 100644 index 0000000000..a8ef77480a --- /dev/null +++ b/talawa-mobile-docs/widgets_rich_text/CustomRichText/CustomRichText.md @@ -0,0 +1,30 @@ + + + +# CustomRichText constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const CustomRichText({required Key key, required this.words}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md b/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md new file mode 100644 index 0000000000..47b3462392 --- /dev/null +++ b/talawa-mobile-docs/widgets_rich_text/CustomRichText/build.md @@ -0,0 +1,86 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return RichText( + textAlign: TextAlign.start, + text: TextSpan( + text: + "${AppLocalizations.of(context)!.strictTranslate(words[0]['text'].toString().trim())} ", + style: words[0]['textStyle'] as TextStyle, + children: List.generate( + words.length - 1, + (index) => TextSpan( + text: + "${AppLocalizations.of(context)!.strictTranslate(words[index + 1]['text'].toString().trim())} ", + style: words[index + 1]['textStyle'] as TextStyle, + ), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md b/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md new file mode 100644 index 0000000000..6f9a309003 --- /dev/null +++ b/talawa-mobile-docs/widgets_rich_text/CustomRichText/words.md @@ -0,0 +1,32 @@ + + + +# words property + + + + + + + +[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_ + + + + + + +## Implementation + +```dart +final List> words; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_rich_text/widgets_rich_text-library.md b/talawa-mobile-docs/widgets_rich_text/widgets_rich_text-library.md new file mode 100644 index 0000000000..40221a34b6 --- /dev/null +++ b/talawa-mobile-docs/widgets_rich_text/widgets_rich_text-library.md @@ -0,0 +1,39 @@ + + + + +# rich_text library + + + + + + + + + + + +## Classes + +##### [CustomRichText](../widgets_rich_text/CustomRichText-class.md) + + + +CustomRichText class returns a widget for customized rich/bold text. +These rich text are being used in form for changing the password. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md new file mode 100644 index 0000000000..55f30f0084 --- /dev/null +++ b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator-class.md @@ -0,0 +1,208 @@ + + + +# SignupProgressIndicator class + + + + + + + + + +

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) +- SignupProgressIndicator + + + + + + + + +## 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}) + + + + +## Properties + +##### [currentPageIndex](../widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md) → [int](https://api.flutter.dev/flutter/dart-core/int-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md new file mode 100644 index 0000000000..a3b52a67b4 --- /dev/null +++ b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/SignupProgressIndicator.md @@ -0,0 +1,30 @@ + + + +# SignupProgressIndicator constructor + + + + + + + +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}) + + + + + +## Implementation + +```dart +SignupProgressIndicator({required Key key, required this.currentPageIndex}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md new file mode 100644 index 0000000000..7ed129c74e --- /dev/null +++ b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/build.md @@ -0,0 +1,119 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Container( + alignment: Alignment.center, + height: SizeConfig.screenHeight! * 0.15, + child: Timeline.tileBuilder( + scrollDirection: Axis.horizontal, + physics: const NeverScrollableScrollPhysics(), + padding: EdgeInsets.zero, + builder: TimelineTileBuilder.connected( + 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 + ? const Color(0xFF008A37) + : const Color(0xFF737373), + ), + textAlign: TextAlign.center, + ), + 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 + ? const Color(0xFF008A37) + : const Color(0xFF737373), + ); + }, + indicatorBuilder: (_, index) { + return DotIndicator( + size: 25, + color: index <= currentPageIndex + ? const Color(0xFF008A37) + : const Color(0xFF737373), + child: index < currentPageIndex + ? const Icon( + Icons.done, + color: Colors.white, + size: 20, + ) + : const SizedBox(), + ); + }, + itemExtentBuilder: (_, __) => MediaQuery.of(context).size.width / 3, + itemCount: 3, + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md new file mode 100644 index 0000000000..f5f2af3eaa --- /dev/null +++ b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/currentPageIndex.md @@ -0,0 +1,32 @@ + + + +# currentPageIndex property + + + + + + + +[int](https://api.flutter.dev/flutter/dart-core/int-class.html) currentPageIndex + +_final_ + + + + + + +## Implementation + +```dart +final int currentPageIndex; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md new file mode 100644 index 0000000000..7bb05930d7 --- /dev/null +++ b/talawa-mobile-docs/widgets_signup_progress_indicator/SignupProgressIndicator/progressLabel.md @@ -0,0 +1,36 @@ + + + +# progressLabel property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[String](https://api.flutter.dev/flutter/dart-core/String-class.html)> progressLabel + +_final_ + + + + + + +## Implementation + +```dart +final List progressLabel = [ + 'Select\nOrganization', + 'Enter Details', + 'Final', +]; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_signup_progress_indicator/widgets_signup_progress_indicator-library.md b/talawa-mobile-docs/widgets_signup_progress_indicator/widgets_signup_progress_indicator-library.md new file mode 100644 index 0000000000..4986b83874 --- /dev/null +++ b/talawa-mobile-docs/widgets_signup_progress_indicator/widgets_signup_progress_indicator-library.md @@ -0,0 +1,39 @@ + + + + +# signup_progress_indicator library + + + + + + + + + + + +## Classes + +##### [SignupProgressIndicator](../widgets_signup_progress_indicator/SignupProgressIndicator-class.md) + + + +This class returns a widget for showing the +progress indicator/flow while Signing Up/ Registration. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md new file mode 100644 index 0000000000..3718686e11 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog-class.md @@ -0,0 +1,206 @@ + + + +# TalawaErrorDialog class + + + + + + + + + + + + +**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) +- TalawaErrorDialog + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [errorMessage](../widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [messageType](../widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md) → [MessageType](../enums_enums/MessageType.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md new file mode 100644 index 0000000000..7ae8a4bd28 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/TalawaErrorDialog.md @@ -0,0 +1,33 @@ + + + +# TalawaErrorDialog constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const TalawaErrorDialog( + this.errorMessage, { + Key? key, + required this.messageType, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md new file mode 100644 index 0000000000..a8c9273fad --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/build.md @@ -0,0 +1,168 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return SizedBox( + child: AlertDialog( + content: SizedBox( + width: 200, + height: 135, + child: Column( + children: [ + SvgPicture.asset( + messageType == MessageType.error + ? 'assets/images/Vector.svg' + : messageType == MessageType.warning + ? 'assets/images/Vector.svg' + : messageType == MessageType.info + ? 'assets/icons/Info.svg' + : 'assets/images/Vector.svg', + colorFilter: ColorFilter.mode( + messageType == MessageType.error + ? Colors.red + : messageType == MessageType.warning + ? Colors.yellow + : messageType == MessageType.info + ? Colors.green + : Colors.red, + BlendMode.srcIn, + ), + ), + const SizedBox( + height: 5, + ), + Text( + messageType == MessageType.error + ? AppLocalizations.of(context)!.strictTranslate('Error') + : messageType == MessageType.warning + ? AppLocalizations.of(context)! + .strictTranslate('Warning') + : messageType == MessageType.info + ? AppLocalizations.of(context)! + .strictTranslate('Information') + : AppLocalizations.of(context)! + .strictTranslate('Error'), + style: TextStyle( + color: messageType == MessageType.error + ? Colors.red + : messageType == MessageType.warning + ? Colors.yellow + : messageType == MessageType.info + ? Colors.green + : Colors.red, + fontSize: 20, + ), + textAlign: TextAlign.center, + ), + const SizedBox( + height: 5, + ), + AutoSizeText( + AppLocalizations.of(context)!.strictTranslate(errorMessage), + style: const TextStyle(fontSize: 16), + maxLines: 3, + ), + const SizedBox( + height: 19, + ), + ], + ), + ), + actions: [ + // Expanded( + // child: + TextButton( + style: TextButton.styleFrom( + backgroundColor: messageType == MessageType.error + ? Colors.red + : messageType == MessageType.warning + ? Colors.red + : messageType == MessageType.info + ? Colors.black26 + : Colors.red, + foregroundColor: Colors.red, + ), + child: Text( + messageType == MessageType.error + ? 'Dismiss' + : messageType == MessageType.warning + ? 'Dismiss' + : messageType == MessageType.info + ? 'Close' + : 'Dismiss', + style: const TextStyle(color: Color.fromRGBO(202, 202, 202, 1)), + ), + onPressed: () { + Navigator.of(context).pop(); + }, + ), + // ), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md new file mode 100644 index 0000000000..b9844493a9 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/errorMessage.md @@ -0,0 +1,32 @@ + + + +# errorMessage property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage + +_final_ + + + + + + +## Implementation + +```dart +final String errorMessage; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md new file mode 100644 index 0000000000..62809db57c --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_dialog/TalawaErrorDialog/messageType.md @@ -0,0 +1,32 @@ + + + +# messageType property + + + + + + + +[MessageType](../../enums_enums/MessageType.md) messageType + +_final_ + + + + + + +## Implementation + +```dart +final MessageType messageType; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_dialog/widgets_talawa_error_dialog-library.md b/talawa-mobile-docs/widgets_talawa_error_dialog/widgets_talawa_error_dialog-library.md new file mode 100644 index 0000000000..c5a3d6a1a7 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_dialog/widgets_talawa_error_dialog-library.md @@ -0,0 +1,38 @@ + + + + +# talawa_error_dialog library + + + + + + + + + + + +## Classes + +##### [TalawaErrorDialog](../widgets_talawa_error_dialog/TalawaErrorDialog-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md new file mode 100644 index 0000000000..8d8412b336 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md @@ -0,0 +1,206 @@ + + + +# TalawaErrorSnackBar class + + + + + + + + + + + + +**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) +- TalawaErrorSnackBar + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [errorMessage](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [messageType](../widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md) → [MessageType](../enums_enums/MessageType.md) + + + + +_final_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md new file mode 100644 index 0000000000..c8d6fa0af1 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/TalawaErrorSnackBar.md @@ -0,0 +1,33 @@ + + + +# TalawaErrorSnackBar constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const TalawaErrorSnackBar({ + Key? key, + required this.errorMessage, + required this.messageType, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md new file mode 100644 index 0000000000..34867b9c11 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/build.md @@ -0,0 +1,121 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Row( + children: [ + Container( + width: 20, + height: 80, + decoration: BoxDecoration( + color: messageType == MessageType.error + ? Colors.red + : messageType == MessageType.warning + ? Colors.yellow + : messageType == MessageType.info + ? Colors.green + : Colors.red, + ), + ), + const SizedBox( + width: 10, + ), + Icon( + messageType == MessageType.error + ? Icons.error + : messageType == MessageType.warning + ? Icons.error + : messageType == MessageType.info + ? Icons.info_outline + : Icons.error, + // Icons.error, + color: messageType == MessageType.error + ? Colors.red + : messageType == MessageType.warning + ? Colors.yellow + : messageType == MessageType.info + ? Colors.green + : Colors.red, + size: 35, + ), + const SizedBox( + width: 10, + ), + Expanded( + flex: 1, + child: SingleChildScrollView( + scrollDirection: Axis.horizontal, + child: Text( + AppLocalizations.of(context)!.strictTranslate(errorMessage), + style: const TextStyle(color: Colors.white), + ), + ), + ) + ], + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md new file mode 100644 index 0000000000..b9844493a9 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/errorMessage.md @@ -0,0 +1,32 @@ + + + +# errorMessage property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) errorMessage + +_final_ + + + + + + +## Implementation + +```dart +final String errorMessage; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md new file mode 100644 index 0000000000..62809db57c --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_snackbar/TalawaErrorSnackBar/messageType.md @@ -0,0 +1,32 @@ + + + +# messageType property + + + + + + + +[MessageType](../../enums_enums/MessageType.md) messageType + +_final_ + + + + + + +## Implementation + +```dart +final MessageType messageType; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_talawa_error_snackbar/widgets_talawa_error_snackbar-library.md b/talawa-mobile-docs/widgets_talawa_error_snackbar/widgets_talawa_error_snackbar-library.md new file mode 100644 index 0000000000..cf70f2bf68 --- /dev/null +++ b/talawa-mobile-docs/widgets_talawa_error_snackbar/widgets_talawa_error_snackbar-library.md @@ -0,0 +1,38 @@ + + + + +# talawa_error_snackbar library + + + + + + + + + + + +## Classes + +##### [TalawaErrorSnackBar](../widgets_talawa_error_snackbar/TalawaErrorSnackBar-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md b/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md new file mode 100644 index 0000000000..f6fad42ea5 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/DescriptionField-class.md @@ -0,0 +1,188 @@ + + + +# DescriptionField class + + + + + + + + + + + + +**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) +- DescriptionField + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md b/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md new file mode 100644 index 0000000000..cc04187762 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/DescriptionField/DescriptionField.md @@ -0,0 +1,29 @@ + + + +# DescriptionField constructor + + + + + + +const +DescriptionField({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const DescriptionField({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md b/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md new file mode 100644 index 0000000000..27bb4f2875 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/DescriptionField/build.md @@ -0,0 +1,100 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + final taskDescriptionTextController = context.select( + (CreateTaskViewModel model) => model.taskDescriptionTextController, + ); + + return TextFormField( + keyboardType: TextInputType.multiline, + controller: taskDescriptionTextController, + validator: (value) => Validator.validateEventForm(value!, 'Description'), + maxLines: 10, + minLines: 1, + decoration: InputDecoration( + hintText: 'Describe the task', + labelText: 'Add Description', + labelStyle: Theme.of(context).textTheme.titleMedium, + border: InputBorder.none, + focusedBorder: InputBorder.none, + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.view_headline, + size: 25, + ), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TaskForm-class.md b/talawa-mobile-docs/widgets_task_form/TaskForm-class.md new file mode 100644 index 0000000000..6f56ca2b49 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TaskForm-class.md @@ -0,0 +1,215 @@ + + + +# TaskForm class + + + + + + + + + + + + +**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) +- TaskForm + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [actionText](../widgets_task_form/TaskForm/actionText.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [title](../widgets_task_form/TaskForm/title.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md b/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md new file mode 100644 index 0000000000..4270294a8f --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TaskForm/TaskForm.md @@ -0,0 +1,34 @@ + + + +# TaskForm constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const TaskForm({ + required this.onSave, + required this.title, + required this.actionText, + Key? key, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md b/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md new file mode 100644 index 0000000000..ca533420f0 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TaskForm/actionText.md @@ -0,0 +1,32 @@ + + + +# actionText property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) actionText + +_final_ + + + + + + +## Implementation + +```dart +final String actionText; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md b/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md new file mode 100644 index 0000000000..f746871161 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TaskForm/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[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 +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +State createState() => _TaskFormState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TaskForm/onSave.md b/talawa-mobile-docs/widgets_task_form/TaskForm/onSave.md new file mode 100644 index 0000000000..3a1d1a70c8 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TaskForm/onSave.md @@ -0,0 +1,32 @@ + + + +# onSave property + + + + + + + +[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)> Function() onSave + +_final_ + + + + + + +## Implementation + +```dart +final Future Function() onSave; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TaskForm/title.md b/talawa-mobile-docs/widgets_task_form/TaskForm/title.md new file mode 100644 index 0000000000..7c14a38648 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TaskForm/title.md @@ -0,0 +1,32 @@ + + + +# title property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) title + +_final_ + + + + + + +## Implementation + +```dart +final String title; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TitleField-class.md b/talawa-mobile-docs/widgets_task_form/TitleField-class.md new file mode 100644 index 0000000000..3a1b005b53 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TitleField-class.md @@ -0,0 +1,188 @@ + + + +# TitleField class + + + + + + + + + + + + +**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) +- TitleField + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md b/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md new file mode 100644 index 0000000000..4ceaed2f95 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TitleField/TitleField.md @@ -0,0 +1,29 @@ + + + +# TitleField constructor + + + + + + +const +TitleField({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const TitleField({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/TitleField/build.md b/talawa-mobile-docs/widgets_task_form/TitleField/build.md new file mode 100644 index 0000000000..8efb4db8d9 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/TitleField/build.md @@ -0,0 +1,98 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + final taskTitleTextController = context + .select((CreateTaskViewModel model) => model.taskTitleTextController); + return TextFormField( + textInputAction: TextInputAction.next, + controller: taskTitleTextController, + keyboardType: TextInputType.name, + maxLength: 100, + validator: (value) => Validator.validateEventForm(value!, 'Title'), + decoration: InputDecoration( + labelText: 'Add Task Title', + isDense: true, + labelStyle: Theme.of(context).textTheme.titleMedium, + focusedBorder: InputBorder.none, + counterText: "", + enabledBorder: InputBorder.none, + prefixIcon: Container( + transform: Matrix4.translationValues( + -SizeConfig.screenWidth! * 0.027, + 0.0, + 0.0, + ), + child: const Icon( + Icons.title, + size: 25, + ), + ), + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_form/widgets_task_form-library.md b/talawa-mobile-docs/widgets_task_form/widgets_task_form-library.md new file mode 100644 index 0000000000..a1a5faa5db --- /dev/null +++ b/talawa-mobile-docs/widgets_task_form/widgets_task_form-library.md @@ -0,0 +1,52 @@ + + + + +# task_form library + + + + + + + + + + + +## Classes + +##### [DescriptionField](../widgets_task_form/DescriptionField-class.md) + + + + + + +##### [TaskForm](../widgets_task_form/TaskForm-class.md) + + + + + + +##### [TitleField](../widgets_task_form/TitleField-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md b/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md new file mode 100644 index 0000000000..75f697cb2f --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskCard-class.md @@ -0,0 +1,215 @@ + + + +# TaskCard class + + + + + + + + + + + + +**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) +- TaskCard + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [appointment](../widgets_task_schedule/TaskCard/appointment.md) → [Appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [showMoreOptions](../widgets_task_schedule/TaskCard/showMoreOptions.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [task](../widgets_task_schedule/TaskCard/task.md) → [Task](../models_task_task_model/Task-class.md) + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md b/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md new file mode 100644 index 0000000000..1f611b973d --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskCard/TaskCard.md @@ -0,0 +1,34 @@ + + + +# TaskCard constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const TaskCard({ + Key? key, + required this.appointment, + required this.showMoreOptions, + required this.task, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md b/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md new file mode 100644 index 0000000000..7c06657a23 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskCard/appointment.md @@ -0,0 +1,32 @@ + + + +# appointment property + + + + + + + +[Appointment](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/Appointment-class.html) appointment + +_final_ + + + + + + +## Implementation + +```dart +final Appointment appointment; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md b/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md new file mode 100644 index 0000000000..3ff8b01218 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskCard/build.md @@ -0,0 +1,153 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return Container( + decoration: BoxDecoration( + color: appointment.color, + borderRadius: const BorderRadius.all( + Radius.circular(4), + ), + ), + padding: const EdgeInsets.only(left: 8), + child: Row( + mainAxisAlignment: MainAxisAlignment.spaceBetween, + children: [ + Column( + crossAxisAlignment: CrossAxisAlignment.start, + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Text( + ' ${appointment.subject}', + style: const TextStyle( + fontWeight: FontWeight.w500, + fontSize: 18, + ), + ), + const SizedBox(height: 8), + Row( + children: [ + const Icon( + Icons.access_time_filled, + size: 16, + ), + const SizedBox(width: 4), + Text( + DateFormat('hh:mm a').format(appointment.endTime), + ), + ], + ), + ], + ), + showMoreOptions + ? IconButton( + onPressed: () { + navigationService.pushDialog( + AlertDialog( + title: Text( + 'User Actions', + style: TextStyle( + color: Theme.of(context).primaryColorLight, + ), + ), + actions: [ + TextButton( + child: const Text('Delete'), + onPressed: () { + context.read().deleteTask( + task.id, + task.creator.id!, + ); + navigationService.pop(); + }, + ), + TextButton( + child: const Text('Edit'), + onPressed: () { + navigationService.pop(); + navigationService.pushScreen( + Routes.editTask, + arguments: task, + ); + }, + ), + TextButton( + child: const Text('Cancel'), + onPressed: () => navigationService.pop(), + ), + ], + ), + ); + }, + icon: const Icon(Icons.more_vert), + ) + : Container(), + ], + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md b/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md new file mode 100644 index 0000000000..8ea6556149 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskCard/showMoreOptions.md @@ -0,0 +1,32 @@ + + + +# showMoreOptions property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions + +_final_ + + + + + + +## Implementation + +```dart +final bool showMoreOptions; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md b/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md new file mode 100644 index 0000000000..3cf99076fd --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskCard/task.md @@ -0,0 +1,32 @@ + + + +# task property + + + + + + + +[Task](../../models_task_task_model/Task-class.md) task + +_final_ + + + + + + +## Implementation + +```dart +final Task task; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md new file mode 100644 index 0000000000..26e9e352d5 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule-class.md @@ -0,0 +1,215 @@ + + + +# TaskSchedule class + + + + + + + + + + + + +**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) +- TaskSchedule + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [showMoreOptions](../widgets_task_schedule/TaskSchedule/showMoreOptions.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_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)> + + + + +_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) + + + +Describes the part of the user interface represented by this widget. +_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 + + + + + + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md new file mode 100644 index 0000000000..06e9a9ce6e --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/TaskSchedule.md @@ -0,0 +1,33 @@ + + + +# TaskSchedule constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const TaskSchedule({ + Key? key, + required this.tasks, + this.showMoreOptions = false, +}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md new file mode 100644 index 0000000000..88667691ac --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/build.md @@ -0,0 +1,91 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + return SfCalendar( + view: CalendarView.schedule, + dataSource: _getCalendarDataSource(tasks), + scheduleViewSettings: const ScheduleViewSettings( + hideEmptyScheduleWeek: true, + appointmentItemHeight: 70, + monthHeaderSettings: MonthHeaderSettings( + height: 0, + ), + ), + onTap: calendarTapped, + appointmentBuilder: (context, appointments) { + final appointment = appointments.appointments.first as Appointment; + final task = tasks.firstWhere((task) => task.id == appointment.id); + return TaskCard( + appointment: appointment, + showMoreOptions: showMoreOptions, + task: task, + ); + }, + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md new file mode 100644 index 0000000000..8f719be54c --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/calendarTapped.md @@ -0,0 +1,75 @@ + + + +# calendarTapped method + + + + + + + + +void calendarTapped +([CalendarTapDetails](https://pub.dev/documentation/syncfusion_flutter_calendar/20.4.54/calendar/CalendarTapDetails-class.html) details) + + + + + + + + +## Implementation + +```dart +void calendarTapped(CalendarTapDetails details) { + if (details.targetElement == CalendarElement.appointment || + details.targetElement == CalendarElement.agenda) { + final Appointment appointmentDetails = + details.appointments![0] as Appointment; + final subjectText = appointmentDetails.subject; + final dateText = + DateFormat('MMMM dd, yyyy').format(appointmentDetails.startTime); + final endTimeText = + DateFormat('hh:mm a').format(appointmentDetails.endTime); + final timeDetails = endTimeText; + + navigationService.pushDialog( + AlertDialog( + title: Text( + subjectText, + style: TextStyle( + color: Theme.of(navigationService.navigatorKey.currentContext!) + .primaryColorLight, + fontWeight: FontWeight.w500, + fontSize: 22, + ), + ), + content: Column( + crossAxisAlignment: CrossAxisAlignment.start, + mainAxisSize: MainAxisSize.min, + children: [ + Text(appointmentDetails.notes!), + const SizedBox(height: 10), + Text('$dateText $timeDetails') + ], + ), + actions: [ + TextButton( + onPressed: () => navigationService.pop(), + child: const Text('Close'), + ) + ], + ), + ); + } +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md new file mode 100644 index 0000000000..8ea6556149 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/showMoreOptions.md @@ -0,0 +1,32 @@ + + + +# showMoreOptions property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) showMoreOptions + +_final_ + + + + + + +## Implementation + +```dart +final bool showMoreOptions; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md new file mode 100644 index 0000000000..d003e0b0e0 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/TaskSchedule/tasks.md @@ -0,0 +1,32 @@ + + + +# tasks property + + + + + + + +[List](https://api.flutter.dev/flutter/dart-core/List-class.html)<[Task](../../models_task_task_model/Task-class.md)> tasks + +_final_ + + + + + + +## Implementation + +```dart +final List tasks; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_task_schedule/widgets_task_schedule-library.md b/talawa-mobile-docs/widgets_task_schedule/widgets_task_schedule-library.md new file mode 100644 index 0000000000..2510a7b761 --- /dev/null +++ b/talawa-mobile-docs/widgets_task_schedule/widgets_task_schedule-library.md @@ -0,0 +1,45 @@ + + + + +# task_schedule library + + + + + + + + + + + +## Classes + +##### [TaskCard](../widgets_task_schedule/TaskCard-class.md) + + + + + + +##### [TaskSchedule](../widgets_task_schedule/TaskSchedule-class.md) + + + + + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md b/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md new file mode 100644 index 0000000000..3a74a348cc --- /dev/null +++ b/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile-class.md @@ -0,0 +1,190 @@ + + + +# ChangeThemeTile class + + + + + + + + + +

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) +- ChangeThemeTile + + + + + + + + +## Constructors + +[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) + + + +The hash code for this object. +_read-onlyinherited_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +Describes the part of the user interface represented by this widget. +_override_ + + + +##### [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_ + + + +##### [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 +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md b/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md new file mode 100644 index 0000000000..88b586d9d9 --- /dev/null +++ b/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/ChangeThemeTile.md @@ -0,0 +1,29 @@ + + + +# ChangeThemeTile constructor + + + + + + +const +ChangeThemeTile({[Key](https://api.flutter.dev/flutter/foundation/Key-class.html)? key}) + + + + + +## Implementation + +```dart +const ChangeThemeTile({Key? key}) : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md b/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md new file mode 100644 index 0000000000..bc0b2b30f6 --- /dev/null +++ b/talawa-mobile-docs/widgets_theme_switch/ChangeThemeTile/build.md @@ -0,0 +1,86 @@ + + + +# build method + + + + + + + +- @[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) + +_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 +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 +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 +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 +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 +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.
  • +
+ + + +## Implementation + +```dart +@override +Widget build(BuildContext context) { + final themeProvider = Provider.of(context); + return ListTile( + key: const Key('ThemeSwitch'), + contentPadding: EdgeInsets.zero, + title: Text(AppLocalizations.of(context)!.strictTranslate("Dark Theme")), + trailing: Switch( + key: const Key('ToggleTheme'), + autofocus: true, + activeColor: Theme.of(context).colorScheme.primary, + value: themeProvider.isdarkTheme, + onChanged: (value) { + final provider = Provider.of(context, listen: false); + provider.switchTheme(isOn: value); + }, + ), + ); +} +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_theme_switch/widgets_theme_switch-library.md b/talawa-mobile-docs/widgets_theme_switch/widgets_theme_switch-library.md new file mode 100644 index 0000000000..7eadafcb60 --- /dev/null +++ b/talawa-mobile-docs/widgets_theme_switch/widgets_theme_switch-library.md @@ -0,0 +1,39 @@ + + + + +# theme_switch library + + + + + + + + + + + +## Classes + +##### [ChangeThemeTile](../widgets_theme_switch/ChangeThemeTile-class.md) + + + +This class enables theme switch. +It returns a ListTile which contains a Toggle button to switch between Dark and Light Themes. + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md b/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md new file mode 100644 index 0000000000..162c160f8b --- /dev/null +++ b/talawa-mobile-docs/widgets_video_widget/VideoWidget-class.md @@ -0,0 +1,207 @@ + + + +# VideoWidget class + + + + + + + + + +

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) +- VideoWidget + + + + + + + + +## 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}) + + _const_ + + +## Properties + +##### [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_ + + + +##### [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_ + + + +##### [play](../widgets_video_widget/VideoWidget/play.md) → [bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) + + + + +_final_ + + + +##### [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_ + + + +##### [url](../widgets_video_widget/VideoWidget/url.md) → [String](https://api.flutter.dev/flutter/dart-core/String-class.html) + + + + +_final_ + + + + + +## Methods + +##### [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_ + + + +##### [createState](../widgets_video_widget/VideoWidget/createState.md)() _VideoWidgetState + + + +Creates the mutable state for this widget at a given location in the tree. +_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)> + + + +Returns a list of DiagnosticsNode objects describing this node's +children. +_inherited_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + +##### [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_ + + + + + +## 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) + + + +The equality operator. +_inherited_ + + + + + + + + + + + + + + + diff --git a/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md b/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md new file mode 100644 index 0000000000..6e7a0763bd --- /dev/null +++ b/talawa-mobile-docs/widgets_video_widget/VideoWidget/VideoWidget.md @@ -0,0 +1,30 @@ + + + +# VideoWidget constructor + + + + + + +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}) + + + + + +## Implementation + +```dart +const VideoWidget({Key? key, required this.url, required this.play}) + : super(key: key); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md b/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md new file mode 100644 index 0000000000..723fd83743 --- /dev/null +++ b/talawa-mobile-docs/widgets_video_widget/VideoWidget/createState.md @@ -0,0 +1,49 @@ + + + +# createState method + + + + + + + +- @[override](https://api.flutter.dev/flutter/dart-core/override-constant.html) + +_VideoWidgetState createState +() + +_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 +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.

+ + + +## Implementation + +```dart +@override +_VideoWidgetState createState() => _VideoWidgetState(); +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_video_widget/VideoWidget/play.md b/talawa-mobile-docs/widgets_video_widget/VideoWidget/play.md new file mode 100644 index 0000000000..6a981df47d --- /dev/null +++ b/talawa-mobile-docs/widgets_video_widget/VideoWidget/play.md @@ -0,0 +1,32 @@ + + + +# play property + + + + + + + +[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html) play + +_final_ + + + + + + +## Implementation + +```dart +final bool play; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md b/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md new file mode 100644 index 0000000000..872efdaa1d --- /dev/null +++ b/talawa-mobile-docs/widgets_video_widget/VideoWidget/url.md @@ -0,0 +1,32 @@ + + + +# url property + + + + + + + +[String](https://api.flutter.dev/flutter/dart-core/String-class.html) url + +_final_ + + + + + + +## Implementation + +```dart +final String url; +``` + + + + + + + diff --git a/talawa-mobile-docs/widgets_video_widget/widgets_video_widget-library.md b/talawa-mobile-docs/widgets_video_widget/widgets_video_widget-library.md new file mode 100644 index 0000000000..bd07455d23 --- /dev/null +++ b/talawa-mobile-docs/widgets_video_widget/widgets_video_widget-library.md @@ -0,0 +1,38 @@ + + + + +# video_widget library + + + + + + + + + + + +## Classes + +##### [VideoWidget](../widgets_video_widget/VideoWidget-class.md) + + + +This class creates a video widget. + + + + + + + + + + + + + + +