Function: getAllProjects()
ts
function getAllProjects(
client,
parameters?,
options?
): Promise<object[]>;Defined in: src/server/api/projects.ts:69
Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters? | { browseArchive?: boolean; expand?: string; includeArchived?: boolean; recent?: number; } | - |
parameters.browseArchive? | boolean | Whether to include only projects where current user can browse archive |
parameters.expand? | string | Parameters to expand |
parameters.includeArchived? | boolean | Whether to include archived projects in response, default: false |
parameters.recent? | number | If this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20) |
options? | RequestOptions | - |
Returns
Promise<object[]>