Skip to content

Class: default

client/apis/UsersAPI.default

Hierarchy

↳ default

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new default(client: default): default

Parameters:

Name Type
client default

Returns: default

Inherited from: default

Defined in: client/apis/UsersAPI.ts:84

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

getAuthenticatedUserInformation

▸ getAuthenticatedUserInformation(): Promise<GetSelfAuthenticatedUserInformation>

Returns: Promise<GetSelfAuthenticatedUserInformation>

Defined in: client/apis/UsersAPI.ts:140

getUserById

▸ getUserById(options: GetUserByIdOptions): Promise<GetUserById>

Parameters:

Name Type
options GetUserByIdOptions

Returns: Promise<GetUserById>

Defined in: client/apis/UsersAPI.ts:129

getUserStatus

▸ getUserStatus(options: GetUserStatusOptions): Promise<GetUserStatus>

Parameters:

Name Type
options GetUserStatusOptions

Returns: Promise<GetUserStatus>

Defined in: client/apis/UsersAPI.ts:178

getUsersByIds

▸ getUsersByIds(options: GetUsersByUserIdsOptions): Promise<GetUsersByUserIds>

Parameters:

Name Type
options GetUsersByUserIdsOptions

Returns: Promise<GetUsersByUserIds>

Defined in: client/apis/UsersAPI.ts:165

getUsersByUsernames

▸ getUsersByUsernames(options: GetUsersByUsernamesOptions): Promise<GetUsersByUsernames>

Parameters:

Name Type
options GetUsersByUsernamesOptions

Returns: Promise<GetUsersByUsernames>

Defined in: client/apis/UsersAPI.ts:152

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name Type
options BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

searchUsers

▸ searchUsers(options: SearchUsersOptions): Promise<SearchUsers>

Parameters:

Name Type
options SearchUsersOptions

Returns: Promise<SearchUsers>

Defined in: client/apis/UsersAPI.ts:202

setDisplayName

▸ setDisplayName(options: SetSelfDisplayNameOptions): Promise<unknown>

Parameters:

Name Type
options SetSelfDisplayNameOptions

Returns: Promise<unknown>

Defined in: client/apis/UsersAPI.ts:116

updateStatus

▸ updateStatus(options: UpdateSelfStatusOptions): Promise<UpdateSelfStatus>

Parameters:

Name Type
options UpdateSelfStatusOptions

Returns: Promise<UpdateSelfStatus>

Defined in: client/apis/UsersAPI.ts:189

validateDisplayNameExistingUser

▸ validateDisplayNameExistingUser(options: ValidateDisplayNameExistingUserOptions): Promise<unknown>

Parameters:

Name Type
options ValidateDisplayNameExistingUserOptions

Returns: Promise<unknown>

Defined in: client/apis/UsersAPI.ts:104

validateDisplayNameNewUser

▸ validateDisplayNameNewUser(options: ValidateDisplayNameNewUserOptions): Promise<unknown>

Parameters:

Name Type
options ValidateDisplayNameNewUserOptions

Returns: Promise<unknown>

Defined in: client/apis/UsersAPI.ts:92