Click or drag to resize

User Class

User handling
Inheritance Hierarchy
SystemObject
  SOWIData.DatabaseConnectorUser
    SOWIApp.Management.DataUser

Namespace:  SOWIApp.Management.Data
Assembly:  SOWIApp.Management (in SOWIApp.Management.dll) Version: 19.1.23.1 (19.1.23.622)
Syntax
public class User : Connector<User>

The User type exposes the following members.

Constructors
  NameDescription
Public methodUser
Initializes a new instance of the User class. Constructor without parameter
Public methodUser(String)
Initializes a new instance of the User class. Constructor with parameter
Public methodUser(Database)
Initializes a new instance of the User class. Constructor with parameter
Public methodUser(String, String)
Initializes a new instance of the User class. Constructor with parameter
Top
Properties
  NameDescription
Public propertyConnectionString
Gives database connection string of the app used
(Inherited from ConnectorDataItemClass.)
Protected propertyDB
Database object. Sets with method SetDB.
(Inherited from ConnectorDataItemClass.)
Public propertyNameUnchanged
Flag no change value in field Name Default: false
(Inherited from ConnectorDataItemClass.)
Public propertyNameUnique
Flag whether Name unique Default: false
(Inherited from ConnectorDataItemClass.)
Protected propertyProvider
Gives data provider type back.
(Inherited from ConnectorDataItemClass.)
Public propertyRecordStandard
Which data items read from database? All, active or archived records.
(Inherited from ConnectorDataItemClass.)
Public propertySortDirectionStandard
Standard sort direction by sort field for example method GeAll
(Inherited from ConnectorDataItemClass.)
Public propertySortFieldStandard
Standard sort field for example method GeAll
(Inherited from ConnectorDataItemClass.)
Public propertyUserName
Gives user name of the app used
(Inherited from ConnectorDataItemClass.)
Protected propertyXML
XML object. Sets with method SetDB
(Inherited from ConnectorDataItemClass.)
Top
Methods
  NameDescription
Public methodCount(Records)
Gives the count by all, active or archive data records
(Inherited from ConnectorDataItemClass.)
Public methodCount(String, Records)
Gives the count by all, active or archive data records and filtering by Name
(Inherited from ConnectorDataItemClass.)
Public methodCountByClient

SOWI App User - Get a number of user by client

Return Value

Type: 

If return a number 0 then no user or over 0 then total users of user by client

If return -1 then function has triggered an exception

Public methodCreate
Create a user
Public methodCode exampleDelete(ListInt32)
Delete all data items
(Inherited from ConnectorDataItemClass.)
Public methodDelete(Int32)
Delete a data item - set Status = Delete (except XML provider)
(Inherited from ConnectorDataItemClass.)
Public methodDelete(String)
Delete data item by Name
(Inherited from ConnectorDataItemClass.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExist(Int32)
Check exist data item by ID (hits can be multiple)
(Inherited from ConnectorDataItemClass.)
Public methodExist(String)
Check exist data item by Name (can be multiple)
(Inherited from ConnectorDataItemClass.)
Private methodExistEmailAddress
Public methodExistOne
Check exist one data item by Name
(Inherited from ConnectorDataItemClass.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAll
Get data list by standards value without parameter.
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(Records)
Get data list by Records (all, active, archived)
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(String, SortDirections)
Get data list details with sort parameters
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(String, Operators, Object)
Get data list by search parameter.
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(String, SortDirections, String, Operators, Object, Records)
Get data list with all parameters.
(Inherited from ConnectorDataItemClass.)
Public methodGetByClient
Gives a user list filtered to client
Private methodGetByEmailAddress
Public methodGetByID
Gives one data item by ID
(Inherited from ConnectorDataItemClass.)
Public methodGetByName
Data item search by field Name
(Inherited from ConnectorDataItemClass.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetList
Gives raw data list and is basis for all data processing
(Overrides ConnectorDataItemClassGetList.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserID

SOWI App User - Get ID by name

Return Value

Type: 

If return a number 0 then no found data item by name

If return a number over 0 then gives ID of data item by name

If return -1 then function has triggered an exception

Public methodInsert(ListDataItemClass)
Insert list of data items
(Inherited from ConnectorDataItemClass.)
Public methodInsert(DataItemClass)
Insert data item
(Inherited from ConnectorDataItemClass.)
Public methodInsertOrUpdateByName
If not exists data record by Name then call method Insert. If exists data record unique then call method Update. If more data records then trigger an exception DataFoundMoreAsOne
(Inherited from ConnectorDataItemClass.)
Public methodLogIn
Check log in
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPasswordChange
User change password
Public methodPasswordReset
User reset password (generated a new password)
Public methodRemove
Delete User incl Address, DataGrid (View: User), ListViewConfig and UserRole
Protected methodSetDB
Set database
(Overrides ConnectorDataItemClassSetDB.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate(ListDataItemClass)
Data list update
(Inherited from ConnectorDataItemClass.)
Public methodUpdate(DataItemClass)
Data item update
(Inherited from ConnectorDataItemClass.)
Public methodValidate
Validate data item
(Inherited from ConnectorDataItemClass.)
Top
Fields
  NameDescription
Public fieldDBActionAfter
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Public fieldDBActionBefore
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldDBActionDone
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldDBActionPermission
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldCode exampleDBActionPrepare
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldValidating
Triggered by method Validate
(Inherited from ConnectorDataItemClass.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetObjectToBytes
Convert an object to byte array
(Defined by Extensions.)
Public Extension MethodIsNumber
Check is value a number
(Defined by Convert.)
Public Extension MethodToHTMLDisplay(DataGrid, TempDataDictionary)Overloaded. (Defined by Extensions.)
Public Extension MethodCode exampleToHTMLDisplay(String, DataGridDataTypes, String, String, String, String, TempDataDictionary)Overloaded.
Gives HTML code for display.
(Defined by Extensions.)
Public Extension MethodToHTMLEditor(DataGrid, TempDataDictionary, String)Overloaded. (Defined by Extensions.)
Public Extension MethodToHTMLEditor(String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String)Overloaded.
Gives HTML code for Input field
(Defined by Extensions.)
Public Extension MethodCode exampleToHTMLHidden(String)Overloaded.
Gives HTML code for hidden data
(Defined by Extensions.)
Public Extension MethodToHTMLHidden(DataGrid)Overloaded.
Gives HTML code for hidden data
(Defined by Extensions.)
Public Extension MethodXMLWrite
Gives XML string from data item
(Defined by Helper.)
Top
Remarks
Name is unique and unchanged
See Also