Class UserIdContext

Context class for User API endpoints that require a "id"

Index

Constructors

Methods

bounties forumposts forumthreads get hof personalstats properties property

Constructors

constructor

new UserIdContext(
requester: Requester,
contextId: string | number,
): UserIdContext
Parameters
- requester: Requester
- contextId: string | number
Returns UserIdContext
- Defined in src/generated/endpoints/user.ts:590

Methods

bounties

bounties(params?: { timestamp?: string }): Promise<UserBountiesResponse>
Get bounties placed on a specific user
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserBountiesResponse>
- Defined in src/generated/endpoints/user.ts:599

forumposts

forumposts(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<UserForumPostsResponse> & UserForumPostsResponse,
>
Get posts for a specific player
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserForumPostsResponse> & UserForumPostsResponse>
- Defined in src/generated/endpoints/user.ts:613

forumthreads

forumthreads(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<
    PaginatedResponse<UserForumThreadsResponse> & UserForumThreadsResponse,
>
Get threads for a specific player
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<UserForumThreadsResponse> & UserForumThreadsResponse>
- Defined in src/generated/endpoints/user.ts:639

get

get(): Promise<User>
Get user by ID

Returns Promise<User>
- Defined in src/generated/endpoints/user.ts:724

hof

hof(params?: { timestamp?: string }): Promise<UserHofResponse>
Get hall of fame rankings for a specific player
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserHofResponse>
- Defined in src/generated/endpoints/user.ts:663

personalstats

personalstats(
    params?: {
        cat?: PersonalStatsCategoryEnum;
        stat?: PersonalStatsStatName[];
        timestamp?: number;
    },
): Promise<UserPersonalStatsResponse>
Get a player's personal stats
Parameters
- Optionalparams: {
      cat?: PersonalStatsCategoryEnum;
      stat?: PersonalStatsStatName[];
      timestamp?: number;
  }
  Optional query parameters
Returns Promise<UserPersonalStatsResponse>
- Defined in src/generated/endpoints/user.ts:675

properties

properties(
params?: { limit?: number; offset?: number; timestamp?: string },
): Promise<
PaginatedResponse<UserPropertiesResponse> & UserPropertiesResponse,
>
Get specific user's properties
Parameters
- Optionalparams: { limit?: number; offset?: number; timestamp?: string }
  Optional query parameters
Returns Promise<PaginatedResponse<UserPropertiesResponse> & UserPropertiesResponse>
- Defined in src/generated/endpoints/user.ts:693

property

property(params?: { timestamp?: string }): Promise<UserPropertyResponse>
Get specific user's property
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserPropertyResponse>
- Defined in src/generated/endpoints/user.ts:713