Class UserIdContext

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

Index

Constructors

constructor

Methods

basic bounties competition faction forumposts forumthreads get hof icons job personalstats profile 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:1013

Methods

basic

basic(
params?: { striptags?: "true" | "false"; timestamp?: string },
): Promise<UserBasicResponse>
Get basic profile information for a specific user
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string }
  Optional query parameters
Returns Promise<UserBasicResponse>
- Defined in src/generated/endpoints/user.ts:1022

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:1038

competition

competition(params?: { timestamp?: string }): Promise<UserCompetitionResponse>
Get competition information for a specific player
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserCompetitionResponse>
- Defined in src/generated/endpoints/user.ts:1052

faction

faction(params?: { timestamp?: string }): Promise<UserFactionResponse>
Get faction information for a specific player
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserFactionResponse>
- Defined in src/generated/endpoints/user.ts:1066

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:1080

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:1106

get

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

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

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:1130

icons

icons(params?: { timestamp?: string }): Promise<UserIconsResponse>
Get icons information for a specific player
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserIconsResponse>
- Defined in src/generated/endpoints/user.ts:1142

job

job(params?: { timestamp?: string }): Promise<UserJobResponse>
Get job information for a specific player
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<UserJobResponse>
- Defined in src/generated/endpoints/user.ts:1156

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:1168

profile

profile(
params?: { striptags?: "true" | "false"; timestamp?: string },
): Promise<UserProfileResponse>
Get profile information for a specific player
Parameters
- Optionalparams: { striptags?: "true" | "false"; timestamp?: string }
  Optional query parameters
Returns Promise<UserProfileResponse>
- Defined in src/generated/endpoints/user.ts:1186

properties

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

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:1224

Class UserIdContext

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserIdContext

Methods

basic

Parameters

Returns Promise<UserBasicResponse>

bounties

Parameters

Returns Promise<UserBountiesResponse>

competition

Parameters

Returns Promise<UserCompetitionResponse>

faction

Parameters

Returns Promise<UserFactionResponse>

forumposts

Parameters

Returns Promise<PaginatedResponse<UserForumPostsResponse> & UserForumPostsResponse>

forumthreads

Parameters

Returns Promise<PaginatedResponse<UserForumThreadsResponse> & UserForumThreadsResponse>

get

Returns Promise<User>

hof

Parameters

Returns Promise<UserHofResponse>

icons

Parameters

Returns Promise<UserIconsResponse>

job

Parameters

Returns Promise<UserJobResponse>

personalstats

Parameters

Returns Promise<UserPersonalStatsResponse>

profile

Parameters

Returns Promise<UserProfileResponse>

properties

Parameters

Returns Promise<PaginatedResponse<UserPropertiesResponse> & UserPropertiesResponse>

property

Parameters

Returns Promise<UserPropertyResponse>

Settings

On This Page