Class SimNewsResource

Sim News resource

See

https://www.swcombine.com/ws/v2.0/documentation/news/simnews/category/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- SimNewsResource

Index

Constructors

Methods

Constructors

constructor

new SimNewsResource(http: HttpClient): SimNewsResource
Parameters
- http: HttpClient
Returns SimNewsResource
Inherited from BaseResource.constructor
- Defined in src/resources/BaseResource.ts:13

Methods

get

get(options: GetNewsItemOptions): Promise<NewsItem>
Get specific Sim News item
Parameters
- options: GetNewsItemOptions
Returns Promise<NewsItem>
- Defined in src/resources/NewsResource.ts:119

list

list(options?: ListSimNewsOptions): Promise<NewsItem[]>
List Sim News items (paginated with optional filtering) @requires_auth No
Parameters
- Optionaloptions: ListSimNewsOptions
  Optional category, pagination, and filtering parameters
  
  SimNews listing options Uses only base options (no faction filtering)
  - Optionalauthor?: string
    Author name to filter by
  - Optionalcategory?: string
    News category to filter by
  - Optionalend_date?: number
    Filter news up to this Unix timestamp
  - Optionalitem_count?: number
    Number of items to retrieve. Default: 50, Max: 50
  - Optionalsearch?: string
    Search term to filter by
  - Optionalstart_date?: number
    Filter news starting from this Unix timestamp
  - Optionalstart_index?: number
    Starting position (1-based). Default: 1
Returns Promise<NewsItem[]>
Example
```
const news = await client.news.simNews.list();
const playerNews = await client.news.simNews.list({ category: 'player' });
const moreNews = await client.news.simNews.list({ start_index: 51, item_count: 50 });
const searchNews = await client.news.simNews.list({ search: 'update', author: 'Admin' });
```
- Defined in src/resources/NewsResource.ts:90