Class ForumEndpoint

Access the Forum API endpoints

Index

Constructors

Methods

categories get lookup threads timestamp withCategoryIds withThreadId

Constructors

constructor

new ForumEndpoint(requester: Requester): ForumEndpoint
Parameters
- requester: Requester
Returns ForumEndpoint
- Defined in src/generated/endpoints/forum.ts:23

Methods

categories

categories(params?: { timestamp?: string }): Promise<ForumCategoriesResponse>
Get publicly available forum categories
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<ForumCategoriesResponse>
- Defined in src/generated/endpoints/forum.ts:31

get

get(
    params?: {
        from?: number;
        id?: number | number[];
        limit?: number;
        offset?: number;
        selections?: string[];
        sort?: "ASC" | "DESC";
        striptags?: "true" | "false";
        timestamp?: string;
        to?: number;
    },
): Promise<ForumResponse>
Get any Forum selection
Parameters
- Optionalparams: {
      from?: number;
      id?: number | number[];
      limit?: number;
      offset?: number;
      selections?: string[];
      sort?: "ASC" | "DESC";
      striptags?: "true" | "false";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<ForumResponse>
- Defined in src/generated/endpoints/forum.ts:95

lookup

lookup(params?: { timestamp?: string }): Promise<ForumLookupResponse>
Get all available forum selections
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<ForumLookupResponse>
- Defined in src/generated/endpoints/forum.ts:67

threads

threads(
    params?: {
        from?: number;
        limit?: number;
        sort?: "ASC" | "DESC";
        timestamp?: string;
        to?: number;
    },
): Promise<PaginatedResponse<ForumThreadsResponse> & ForumThreadsResponse>
Get threads across all forum categories
Parameters
- Optionalparams: {
      from?: number;
      limit?: number;
      sort?: "ASC" | "DESC";
      timestamp?: string;
      to?: number;
  }
  Optional query parameters
Returns Promise<PaginatedResponse<ForumThreadsResponse> & ForumThreadsResponse>
- Defined in src/generated/endpoints/forum.ts:45

timestamp

timestamp(params?: { timestamp?: string }): Promise<TimestampResponse>
Get current server time
Parameters
- Optionalparams: { timestamp?: string }
  Optional query parameters
Returns Promise<TimestampResponse>
- Defined in src/generated/endpoints/forum.ts:81

withCategoryIds

withCategoryIds(categoryIds: string | number): ForumCategoryIdsContext
Parameters
- categoryIds: string | number
  The ID for this context
Returns ForumCategoryIdsContext
- Defined in src/generated/endpoints/forum.ts:127

withThreadId

withThreadId(threadId: string | number): ForumThreadIdContext
Parameters
- threadId: string | number
  The ID for this context
Returns ForumThreadIdContext
- Defined in src/generated/endpoints/forum.ts:122