[ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)

* [ADF-2847] Added class members heading to content services docs * [ADF-2847] Updated all prop/method tables in content services
2026-09-09 18:03:21 +00:00 · 2018-04-26 14:54:25 +01:00
parent 616036f9e7
commit 2c0e7aa035
40 changed files with 541 additions and 405 deletions
@@ -12,49 +12,57 @@ Manages Document List information that is specific to a user.

 ### Methods

-   `getRecentFiles(personId: string, pagination: PaginationModel): Observable<NodePaging>`<br/>
-    Gets files recently accessed by a user.
-    -   `personId: string` -  ID of the user
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   **Returns** `Observable<NodePaging>` - List of nodes for the recently used files
-   `loadFavorites(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>`<br/>
-    Gets favorite files for the current user.
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   `includeFields: string[] = []` -  List of data field names to include in the results
-    -   **Returns** `Observable<NodePaging>` - List of favorite files
-   `loadMemberSites(pagination: PaginationModel): Observable<NodePaging>`<br/>
-    Gets sites that the current user is a member of.
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   **Returns** `Observable<NodePaging>` - List of sites
-   `loadSites(pagination: PaginationModel): Observable<NodePaging>`<br/>
-    Gets all sites in the respository.
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   **Returns** `Observable<NodePaging>` - List of sites
-   `loadTrashcan(pagination: PaginationModel, includeFields: string[] = []): Observable<DeletedNodesPaging>`<br/>
-    Gets all items currently in the trash.
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   `includeFields: string[] = []` -  List of data field names to include in the results
-    -   **Returns** `Observable<DeletedNodesPaging>` - List of deleted items
-   `loadSharedLinks(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>`<br/>
-    Gets shared links for the current user.
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   `includeFields: string[] = []` -  List of data field names to include in the results
-    -   **Returns** `Observable<NodePaging>` - List of shared links
-   `isCustomSource(folderId: string): boolean`<br/>
-    Is the folder ID one of the well-known aliases?
-    -   `FolderId` -  Folder ID name to check
-    -   **Returns** `Observable<NodePaging>` - True if the ID is a well-known name, false otherwise
-   `loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[]): Observable<NodePaging>`<br/>
-    Gets a folder's contents.
-    -   `nodeId: string` -  ID of the target folder node
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   `includeFields: string[] = []` -  List of data field names to include in the results
-    -   **Returns** `Observable<NodePaging>` - List of items contained in the folder
-   `getCorrespondingNodeIds(nodeId: string, pagination: PaginationModel): Observable<string[]>`<br/>
-    Gets the contents of one of the well-known aliases in the form of node ID strings.
-    -   `nodeId: string` -  ID of the target folder node
-    -   `pagination: PaginationModel` -  Specifies how to paginate the results
-    -   **Returns** `Observable<string[]>` - List of node IDs
+-   `getCorrespondingNodeIds(nodeId: string = null, pagination: PaginationModel = null): Observable<string[]>`<br/>
+
+    -   `nodeId: string = null` -  
+    -   `pagination: PaginationModel = null` -  
+    -   **Returns** `Observable<string[]>` - 
+
+-   `getRecentFiles(personId: string = null, pagination: PaginationModel = null): Observable<NodePaging>`<br/>
+
+    -   `personId: string = null` -  
+    -   `pagination: PaginationModel = null` -  
+    -   **Returns** `Observable<NodePaging>` - 
+
+-   `isCustomSource(folderId: string = null): boolean`<br/>
+
+    -   `folderId: string = null` -  
+    -   **Returns** `boolean` - 
+
+-   `loadFavorites(pagination: PaginationModel = null, includeFields: string[] =  []): Observable<NodePaging>`<br/>
+
+    -   `pagination: PaginationModel = null` -  
+    -   `includeFields: string[] =  []` -  
+    -   **Returns** `Observable<NodePaging>` - 
+
+-   `loadFolderByNodeId(nodeId: string = null, pagination: PaginationModel = null, includeFields: string[] = null): Observable<NodePaging>`<br/>
+
+    -   `nodeId: string = null` -  
+    -   `pagination: PaginationModel = null` -  
+    -   `includeFields: string[] = null` -  
+    -   **Returns** `Observable<NodePaging>` - 
+
+-   `loadMemberSites(pagination: PaginationModel = null): Observable<NodePaging>`<br/>
+
+    -   `pagination: PaginationModel = null` -  
+    -   **Returns** `Observable<NodePaging>` - 
+
+-   `loadSharedLinks(pagination: PaginationModel = null, includeFields: string[] =  []): Observable<NodePaging>`<br/>
+
+    -   `pagination: PaginationModel = null` -  
+    -   `includeFields: string[] =  []` -  
+    -   **Returns** `Observable<NodePaging>` - 
+
+-   `loadSites(pagination: PaginationModel = null): Observable<NodePaging>`<br/>
+
+    -   `pagination: PaginationModel = null` -  
+    -   **Returns** `Observable<NodePaging>` - 
+
+-   `loadTrashcan(pagination: PaginationModel = null, includeFields: string[] =  []): Observable<DeletedNodesPaging>`<br/>
+
+    -   `pagination: PaginationModel = null` -  
+    -   `includeFields: string[] =  []` -  
+    -   **Returns** `Observable<DeletedNodesPaging>` -

 ## Details