Function getAllProjects

getAllProjects(
    client: Client,
    parameters?: {
        browseArchive?: boolean;
        expand?: string;
        includeArchived?: boolean;
        recent?: number;
    },
    options?: RequestOptions,
): Promise<
    {
        archived?: boolean;
        avatarUrls?: Record<string, string>;
        description?: string;
        id?: string;
        key?: string;
        name?: string;
        self?: string;
        [key: string]: unknown;
    }[],
>
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
- client: Client
- Optionalparameters: {
      browseArchive?: boolean;
      expand?: string;
      includeArchived?: boolean;
      recent?: number;
  }
  - OptionalbrowseArchive?: boolean
    
    Whether to include only projects where current user can browse archive
  - Optionalexpand?: string
    
    Parameters to expand
  - OptionalincludeArchived?: boolean
    
    Whether to include archived projects in response, default: false
  - Optionalrecent?: 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)
- Optionaloptions: RequestOptions
Returns Promise<
    {
        archived?: boolean;
        avatarUrls?: Record<string, string>;
        description?: string;
        id?: string;
        key?: string;
        name?: string;
        self?: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/server/api/projects.ts:69

Function getAllProjects

Parameters

`Optional`browseArchive?: boolean

`Optional`expand?: string

`Optional`includeArchived?: boolean

`Optional`recent?: number

Returns Promise<
    {
        archived?: boolean;
        avatarUrls?: Record<string, string>;
        description?: string;
        id?: string;
        key?: string;
        name?: string;
        self?: string;
        [key: string]: unknown;
    }[],
>

Settings

Function getAllProjects

Parameters

OptionalbrowseArchive?: boolean

Optionalexpand?: string

OptionalincludeArchived?: boolean

Optionalrecent?: number

Returns Promise< { archived?: boolean; avatarUrls?: Record<string, string>; description?: string; id?: string; key?: string; name?: string; self?: string; [key: string]: unknown; }[],>

Settings

`Optional`browseArchive?: boolean

`Optional`expand?: string

`Optional`includeArchived?: boolean

`Optional`recent?: number

Returns Promise<
{
archived?: boolean;
avatarUrls?: Record<string, string>;
description?: string;
id?: string;
key?: string;
name?: string;
self?: string;
[key: string]: unknown;
}[],
>