Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct GetUsersBasicSearch docs #5413

Merged
merged 1 commit into from
Nov 29, 2022
Merged

Correct GetUsersBasicSearch docs #5413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions DNN Platform/Library/Entities/Users/IUserController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ IList<UserInfo> GetUsersAdvancedSearch(
string propertyNames,
string propertyValues);

/// <summary>Searches for users via user fields and profile properties.</summary>
/// <summary>Searches for users via a user property.</summary>
/// <param name="portalId">The portal ID in which to search for users.</param>
/// <param name="pageIndex">The 0-based page index.</param>
/// <param name="pageSize">The number of results to return in each page.</param>
/// <param name="sortColumn">The name of the column/property to sort by. Sorts by <see cref="IUserInfo.UserID"/> if not supplied.</param>
/// <param name="sortAscending">Whether the sort is ascending or descending.</param>
/// <param name="propertyName">A comma-delimited list of property names (e.g. <c>"Username,Street1"</c>).</param>
/// <param name="propertyValue">A comma-delimited list of property values (e.g. <c>"jane,123 Street"</c>).</param>
/// <param name="propertyName">A property name (i.e. a column from <c>vw_Users</c>, for example <c>"Username"</c>, <c>"DisplayName"</c> or <c>"Email"</c>).</param>
/// <param name="propertyValue">The value to search by, results will contain this text in the property.</param>
/// <returns>A list of <see cref="UserInfo"/> instances.</returns>
IList<UserInfo> GetUsersBasicSearch(
int portalId,
Expand Down