Engine_Database.Get_User_Folder_Browse Method
Get a browse of all items in a user's folder
Namespace: SobekCM.Engine_Library.DatabaseAssembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)
Syntax
C# |
---|
public static Single_Paged_Results_Args Get_User_Folder_Browse(
int UserID,
string FolderName,
int ResultsPerPage,
int ResultsPage,
bool IncludeFacets,
List<short> FacetTypes,
bool ReturnSearchStatistics,
Custom_Tracer Tracer
) |
Parameters
- UserID
- Type: System..::..Int32
Primary key for this user in the database
- FolderName
- Type: System..::..String
Name of this user's folder
- ResultsPerPage
- Type: System..::..Int32
Number of results to return per "page" of results
- ResultsPage
- Type: System..::..Int32
Which page of results to return ( one-based, so the first page is page number of one )
- IncludeFacets
- Type: System..::..Boolean
Flag indicates if facets should be included in the final result set
- FacetTypes
- Type: System.Collections.Generic..::..List<(Of <(<'Int16>)>)>
Primary key for the metadata types to include as facets (up to eight)
- ReturnSearchStatistics
- Type: System..::..Boolean
Flag indicates whether to create and return statistics about the overall search results, generally set to TRUE for the first page requested and subsequently set to FALSE
- Tracer
- Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Return Value
Type:
Single_Paged_Results_Args List of items matching search
Remarks
See Also