Class FactionMembersResource

Faction members resource

See

https://www.swcombine.com/ws/v2.0/documentation/faction/fuid/members/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- FactionMembersResource

Index

Constructors

Methods

list updateMemberInfo

Constructors

constructor

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

Methods

list

list(
    options: {
        factionId: string;
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<FactionMember>>
List faction members (paginated)
Parameters
- options: {
      factionId: string;
      item_count?: number;
      pageDelay?: number;
      start_index?: number;
  }
  Faction ID and optional pagination parameters
Returns Promise<Page<FactionMember>>
Example
```
const page = await client.faction.members.list({ factionId: '20:123' });
console.log(page.data); // FactionMember[]
// Iterate all pages:
for await (const member of page) { console.log(member); }
```
- Defined in src/resources/FactionResource.ts:60

updateMemberInfo

updateMemberInfo(
    options: {
        factionId: string;
        new_value: string;
        property: "info1" | "info2" | "info3";
        uid: string;
    },
): Promise<Record<string, unknown>>
Update faction member info field
Parameters
- options: {
      factionId: string;
      new_value: string;
      property: "info1" | "info2" | "info3";
      uid: string;
  }
  - factionId: string
    Faction UID
  - new_value: string
    New value for the info field
  - property: "info1" | "info2" | "info3"
    Which info field to update (info1, info2, or info3)
  - uid: string
    Character UID to update
Returns Promise<Record<string, unknown>>
- Defined in src/resources/FactionResource.ts:97