Login Screen Configuration
On the login Screen the below are configurable
- Show password checkbox
- Login logo
- Login background
These configurations will be specified in the metadata attribute of the view configuration file for login screen. An example of the login configuration screen will be a shown below
Image Added
| Property | Data Type | Desciption |
|---|
| _id | String | CouchDB Internal document ID used to differentiate different documents within CouchDB |
| _rev | String | CouchDB Internal document revision number used to differentiate different revisions of the same documents within CouchDB. Dont amend this manually |
| serverVersion | long | A long number denoting the unix timestamp when the document was updated/created. Its used for versioning by clients. Whenever a document is amended this property should be incremented to the current timestamp so that clients notice the document has changed and they can sync it. |
| type | string | CouchDB Internal document type used to differentiate different documents types within CouchDB. This should always be ViewConfiguration |
| identifier | String | This uniquely identifies this document. This will be used on the client to identify that this document if for a particular screen. This should not be amended |
| metadata | Object | This is an object that contains configurations at the screen level. |
| Metadata Object |
|
|
|---|
| Property | Type | desciption |
|---|
| type | String | This identifiers the type of Metadata. For the login Screen it will always be Login | | showPasswordCheckbox | Boolean | This will control if the Show Password Checkbox will be displayed | | logoUrl | String | This is String containing a URL pointing to the location of the login logo. The client will download the logo and cache the logo which will now be displayed on Login screen instead of the default. Its recommended you provide a square high resolution image so that logo is scalled properly even in clients with high resulotion displays | | background | Object | This is an object that contains the configurations for background gradient of the login page |
| Background Object |
|---|
| Property | Type | Desciption |
|---|
| orientation | String | The orientation of the gradient. It Controls how the gradient is oriented relative to the drawable's bounds. It can be any of - BL_TR
- BOTTOM_TOP
- BR_TL
- LEFT_RIGHT
- RIGHT_LEFT
- TL_BR
- TOP_BOTTOM
- TR_BL
Refer to https://developer.android.com/reference/android/graphics/drawable/GradientDrawable.Orientation.html for more details | | startColor | String | The start color of the login screen background gradient. May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb". | | endColor | String | The end color of the login screen background gradient. May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb". |
|
|