[This is preliminary documentation and is subject to change.]

The UserDB type exposes the following members.

Constructors

  NameDescription
Public methodUserDB

Methods

  NameDescription
Public methodAddOutputParameterOverloaded.
Public methodAddParameterOverloaded.
Protected methodAddParametersOverloaded.
Public methodAdjustUserCurrencyDefault
Public methodClearParameters
Clear all the sql stored procedure parameters
(Inherited from OfficeClipDB.)
Public methodClose
Close the connection, data adapter and the command
(Inherited from OfficeClipDB.)
Public methodCommit
Commits the transaction
(Inherited from OfficeClipDB.)
Public methodDispose
disposes the object for garbage collection
(Inherited from OfficeClipDB.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodExecuteNonQueryOverloaded.
Protected methodExecuteReader
Executes the sql datareader
(Inherited from OfficeClipDB.)
Protected methodExecuteScalar
Executes the query that returns a single valur
(Inherited from OfficeClipDB.)
Public methodExportCsv
Get the CSV formatted text for the selected fields from the users's details corresponding to a particular group.
Public methodExportVCard
Gets the all the information of all the members of a particular group in a VCard format.
Protected methodFill
Fills the dataset
(Inherited from OfficeClipDB.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAllUsers
Gets all the users from the OfficeClip System.
Public methodGetAlphabetLinks
Returns the first alphabets of the first name or the last name depending on the value of orderBy argument for a particular group.
Public methodGetHashCode
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
Public methodGetMembersList
Returns all the user from a system who can be seen by a particular user.
Public methodGetNonGroupMemberList
This method returns a set of all the members of the OfficeClip account who are not a member of a given group.
Public methodGetNonMembersList
Returns all the user who can be seen by a particular user, and does not belong to a particular group.
Public methodGetParameterCount
Gets the parameter count
(Inherited from OfficeClipDB.)
Public methodGetParameterValue
Gets the value of the parameter
(Inherited from OfficeClipDB.)
Public methodGetPassword
Gets the password string for a particular user, this string is used to compare the user's password to allow user entry to the system. The string being compared to and the password value obtained from the database both are in one way encrypted format.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserIdFromEmail
Get the user's id from the given the email Address in a particular group.
Public methodGetUsersByGroup
Gets all the users for a particular group sorted by a given sort condition.
Protected methodInit
Initialize the connection parameters
(Inherited from OfficeClipDB.)
Public methodInitTransactionOverloaded.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodResetPassword
Resets user password and the mail is sent using the name and email Address of the currently logged in user.
Public methodResetPasswordInDatabase
Resets the password in the database and returns the password in cleartext as the output. This method is required because it will encourage reuse of this part for both reset password and Reinvite members
Public methodRollback
Rolls back the transaction
(Inherited from OfficeClipDB.)
Public methodSearchUsers
Gets the information of all the users for a particular user matching the search criteria.
Public methodSetAdminStatus
Grants or revokes admin privileges to a set of users in a particular group.
Public methodSetParameterValue
Sets the parameter value of the sql parameter to a known value
(Inherited from OfficeClipDB.)
Protected methodSetSPCommandOverloaded.
Protected methodSetSPDataAdapter
Sets the stored procedure data adapter
(Inherited from OfficeClipDB.)
Public methodSetSuccessfulLoginDate
Sets a Timestamp in the database which marking the the user's login date and time for the user who is currently logging in.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUpdatePassword
Encrypts the password for a particular user using the MD5 algorithm and saves the password in the database.
Public methodUpdatePin
Encrypts the user pin number (used for mobile access) for a particular user using the MD5 algorithm and saves the password in the database.
Public methodUpdateUserCurrency

Properties

  NameDescription
Public propertyConnectionString
Gets the OfficeClip.DBLayer.ConnectionString property encapsulates a callout to the ASP+ Config System to obtain the database connection string for the application.
(Inherited from OfficeClipDB.)
Protected propertyDBConnString
The database connection string that is only available within the framework of the DBLayer. This should only be set through a constructor so this is not available outside the DBLayer. A default conection string is assumed if not set.
(Inherited from OfficeClipDB.)

See Also