[This is preliminary documentation and is subject to change.]
Gets all the users for a particular group sorted by a given sort condition.
Namespace:
OfficeClip.DBLayer.AccountAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public List<UserInfo> GetUsersByGroup( SortByName orderBy, int groupId, UserType userType ) |
Visual Basic (Declaration) |
---|
Public Function GetUsersByGroup ( _ orderBy As SortByName, _ groupId As Integer, _ userType As UserType _ ) As List(Of UserInfo) |
Visual C++ |
---|
public: List<UserInfo^>^ GetUsersByGroup( SortByName orderBy, int groupId, UserType userType ) |
Parameters
- orderBy
- Type: OfficeClip.Utils..::.SortByName
Enumerated value determining whether to sort the user list by the first character of the first name or last name. SortByName
- groupId
- Type: System..::.Int32
Id of the group.
- userType
- Type: OfficeClip.Utils..::.UserType
Return Value
DataSet containing information related to the users for the currently selected group. This DataSet consists of a single DataTable with the following columns.- groupType (System.String)Flag (P,G,D,O) indicating the type of the group.
- UserId (System.Int32)Id of the user.
- IsAdmin (System.String)Flag (Y/N) indicating whether this user is the admin this particular group.
- userDetailId (System.Int32)userDetailId of the user.
- IsRegistered (System.String)Flag (Y/N) indicating whether the user is registered in this particular group or not.
- emailAddress (System.String)Email Address of the user.
- name (System.String)Name of the user (first name and last name concatenated by a blank space).
- nameAndEmail (System.String)Name and email Address of the user.
- firstAlphabet (System.String)First alphabet of either the first name or the last name depending upon the sort criteria mentioned above.
- location (System.String)location of the user.
- WorkTitle (System.String)Work title 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.
- workPhoneSecondary (System.String)Secondary work phone number.
- otherPhone (System.String)Other phone number.
- cellPhone (System.String)Cell or mobile phone number of the user.
- faxNumber (System.String)Fax number of the user.
- message (System.String)If the user has left a notice or a message to the group members.
- LastUpdatedTimestamp (System.DateTime)Date and time when the user's information was last updated.
- joiningTimestamp (System.DateTime)Date and Time when this user joined this particular group.
- InvitationStatus (System.String)Flag (A,R,P,N) indicating whether the user has accepted (A) the invitation or rejected (R) the invitation, or the invitation is pending (P) or it is a record corresponding to a address book (N) which none of the above.
- organization (System.String)organization to which the user belongs.
- BirthDate (System.DateTime)Date of the birth of the user.
- waline1 (System.String)First line of the work Address of the user.
- waline2 (System.String)Second line of the work Address of the user.
- wacity (System.String)City of the work Address of the user.
- wastate (System.String)State of the work Address of the user.
- wazip (System.String)Zip code of the work Address of the user.
- wacountry (System.String)Country of the work Address of the user.
- haline1 (System.String)First line of the home Address of the user.
- haline2 (System.String)Second line of the home Address of the user.
- hacity (System.String)City of the home Address of the user.
- hastate (System.String)State of the home Address of the user.
- hazip (System.String)Zip code of the home Address of the user.
- hacountry (System.String)Country of the home Address of the user.