Module: client/apis/UsersAPI
Table of contents
Classes
Type aliases
- GetSelfAuthenticatedUserInformation
- GetUserById
- GetUserByIdOptions
- GetUserStatus
- GetUserStatusOptions
- GetUsersByUserIds
- GetUsersByUserIdsOptions
- GetUsersByUsernames
- GetUsersByUsernamesOptions
- SearchUsers
- SearchUsersOptions
- SetSelfDisplayName
- SetSelfDisplayNameOptions
- UpdateSelfStatus
- UpdateSelfStatusOptions
- ValidateDisplayNameExistingUser
- ValidateDisplayNameExistingUserOptions
- ValidateDisplayNameNewUser
- ValidateDisplayNameNewUserOptions
Type aliases
GetSelfAuthenticatedUserInformation
Ƭ GetSelfAuthenticatedUserInformation: object
Type declaration:
| Name | Type |
|---|---|
displayName |
string |
id |
number |
name |
string |
Defined in: client/apis/UsersAPI.ts:31
GetUserById
Ƭ GetUserById: object
Type declaration:
| Name | Type |
|---|---|
created |
string |
description |
string |
displayName |
string |
id |
number |
isBanned |
boolean |
name |
string |
Defined in: client/apis/UsersAPI.ts:23
GetUserByIdOptions
Ƭ GetUserByIdOptions: object
Type declaration:
| Name | Type |
|---|---|
userId |
number |
Defined in: client/apis/UsersAPI.ts:20
GetUserStatus
Ƭ GetUserStatus: object
Type declaration:
| Name | Type |
|---|---|
status |
string |
Defined in: client/apis/UsersAPI.ts:58
GetUserStatusOptions
Ƭ GetUserStatusOptions: object
Type declaration:
| Name | Type |
|---|---|
userId |
number |
Defined in: client/apis/UsersAPI.ts:55
GetUsersByUserIds
Ƭ GetUsersByUserIds: object
Type declaration:
| Name | Type |
|---|---|
data |
Omit<GetUsersByUsernames[data][0], requestedUsername>[] |
Defined in: client/apis/UsersAPI.ts:52
GetUsersByUserIdsOptions
Ƭ GetUsersByUserIdsOptions: object
Type declaration:
| Name | Type |
|---|---|
excludeBannedUsers? |
boolean |
userIds |
number[] |
Defined in: client/apis/UsersAPI.ts:48
GetUsersByUsernames
Ƭ GetUsersByUsernames: object
Type declaration:
| Name | Type |
|---|---|
data |
{ displayName: string ; id: number ; name: string ; requestedUsername: string }[] |
Defined in: client/apis/UsersAPI.ts:40
GetUsersByUsernamesOptions
Ƭ GetUsersByUsernamesOptions: object
Type declaration:
| Name | Type |
|---|---|
excludeBannedUsers? |
boolean |
usernames |
string[] |
Defined in: client/apis/UsersAPI.ts:36
SearchUsers
Ƭ SearchUsers: object
Type declaration:
| Name | Type |
|---|---|
data |
{ displayName: string ; id: number ; name: string ; previousUsernames: string[] }[] |
nextPageCursor |
string |
previousPageCursor |
string |
Defined in: client/apis/UsersAPI.ts:73
SearchUsersOptions
Ƭ SearchUsersOptions: object
Type declaration:
| Name | Type |
|---|---|
cursor? |
string |
keyword |
string |
limit? |
10 | 25 | 50 | 100 |
Defined in: client/apis/UsersAPI.ts:68
SetSelfDisplayName
Ƭ SetSelfDisplayName: unknown
Defined in: client/apis/UsersAPI.ts:19
SetSelfDisplayNameOptions
Ƭ SetSelfDisplayNameOptions: object
Type declaration:
| Name | Type |
|---|---|
newDisplayName |
string |
userId |
number |
Defined in: client/apis/UsersAPI.ts:15
UpdateSelfStatus
Ƭ UpdateSelfStatus: object
Type declaration:
| Name | Type |
|---|---|
status |
string |
Defined in: client/apis/UsersAPI.ts:65
UpdateSelfStatusOptions
Ƭ UpdateSelfStatusOptions: object
Type declaration:
| Name | Type |
|---|---|
status |
string |
userId |
number |
Defined in: client/apis/UsersAPI.ts:61
ValidateDisplayNameExistingUser
Ƭ ValidateDisplayNameExistingUser: unknown
Defined in: client/apis/UsersAPI.ts:14
ValidateDisplayNameExistingUserOptions
Ƭ ValidateDisplayNameExistingUserOptions: object
Type declaration:
| Name | Type |
|---|---|
displayName |
string |
userId |
number |
Defined in: client/apis/UsersAPI.ts:10
ValidateDisplayNameNewUser
Ƭ ValidateDisplayNameNewUser: unknown
Defined in: client/apis/UsersAPI.ts:9
ValidateDisplayNameNewUserOptions
Ƭ ValidateDisplayNameNewUserOptions: object
Type declaration:
| Name | Type |
|---|---|
birthdate |
string |
displayName |
string |
Defined in: client/apis/UsersAPI.ts:5