[This is preliminary documentation and is subject to change.]
Gets the information of all the users for a particular user
matching the search criteria.
Namespace:
OfficeClip.DBLayer.DesktopAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public DataTable SearchUsers( int userId, int groupId, string searchText, string searchBy, bool isAdmin ) |
Visual Basic (Declaration) |
---|
Public Function SearchUsers ( _ userId As Integer, _ groupId As Integer, _ searchText As String, _ searchBy As String, _ isAdmin As Boolean _ ) As DataTable |
Visual C++ |
---|
public: DataTable^ SearchUsers( int userId, int groupId, String^ searchText, String^ searchBy, bool isAdmin ) |
Parameters
- userId
- Type: System..::.Int32
The unique user id.
- groupId
- Type: System..::.Int32
The unique id of the organization
- searchText
- Type: System..::.String
The text string to search for.
- searchBy
- Type: System..::.String
This parameter can take the following values indicating which field to use for while searching.- firstname
- lastname
- emailaddress
- initials
- all
- isAdmin
- Type: System..::.Boolean
Is the current user an administrator
Return Value
DataSet containing the information of the users matching the search criteria. This DataSet consists of a single DataTable with the following columns.- userDetailId (System.Int32)userDetailId of the user.
- UserId (System.Int32)Id of the user.
- UserName (System.String)Name of the user (first name and last name concatenated by a blank space).
- emailAddress (System.String)Email Address of the user.
- PreferredPhoneNumber (System.String)One of the phone numbers of work phone primary, work phone secondary, other phone, home phone or the cell phone based on the preference set by the user as the most preferred number to contacted at. If the user has not set the preference, then the primary work phone nuber is returned.
- workPhonePrimary (System.String)Primary work phone number.
- GroupId (System.Int32)Id of the group to which the user matching he search criteria belongs.
- groupType (System.String)Flag (P,G,D,O) indicating the type of the group.
- groupName (System.String)Name of the group.
- groupIE (System.String)Flag (I,E) indicating whether the user matching the search criteria is internal or external to the OfficeClip system i.e. whether it is address book entry or a member.
- IsRegistered (System.String)Flag (Y/N) indicating whether the user is registered in this particular group or not.