Function findUsersForPicker

findUsersForPicker(
    client: Client,
    parameters?: {
        exclude?: string[];
        maxResults?: number;
        query?: string;
        showAvatar?: boolean;
    },
    options?: RequestOptions,
): Promise<
    {
        header?: string;
        total?: number;
        users?: {
            avatarUrl?: string;
            displayName?: string;
            html?: string;
            key?: string;
            name?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Returns a list of users matching query with highlighting.
Parameters
- client: Client
- Optionalparameters: {
      exclude?: string[];
      maxResults?: number;
      query?: string;
      showAvatar?: boolean;
  }
  - Optionalexclude?: string[]
    
    List of users to be excluded from the search results
  - OptionalmaxResults?: number
    
    The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.
  - Optionalquery?: string
    
    A string used to search username, Name or e-mail address
  - OptionalshowAvatar?: boolean
    
    If true, then avatars are included in the results
- Optionaloptions: RequestOptions
Returns Promise<
    {
        header?: string;
        total?: number;
        users?: {
            avatarUrl?: string;
            displayName?: string;
            html?: string;
            key?: string;
            name?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/server/api/users.ts:655

Function findUsersForPicker

Parameters

`Optional`exclude?: string[]

`Optional`maxResults?: number

`Optional`query?: string

`Optional`showAvatar?: boolean

Settings

Function findUsersForPicker

Parameters

Optionalexclude?: string[]

OptionalmaxResults?: number

Optionalquery?: string

OptionalshowAvatar?: boolean

Returns Promise< { header?: string; total?: number; users?: { avatarUrl?: string; displayName?: string; html?: string; key?: string; name?: string; [key: string]: unknown; }[]; [key: string]: unknown; },>

Settings

`Optional`exclude?: string[]

`Optional`maxResults?: number

`Optional`query?: string

`Optional`showAvatar?: boolean

Returns Promise<
{
header?: string;
total?: number;
users?: {
avatarUrl?: string;
displayName?: string;
html?: string;
key?: string;
name?: string;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>