Class APISocials

Index

Constructors

Methods

createSocial deleteSocial getSocials updateSocial

Constructors

constructor

new APISocials(web): APISocials
Parameters
- web: WebDataManager
Returns APISocials
- Defined in src/classes/socials.ts:8

Methods

createSocial

createSocial(__namedParameters): Promise<WebResponse<{
    account: {
        created: boolean;
        dbId: string;
    };
    view: null | SocialAccountsView;
}>>
Link an X or Club account by its handle (@name, a profile link, or the bare name). Typed links are unverified. Errors: 400 invalid handle, 404 no such account, 409 limit / taken / locked, 403 banned or not available, 429 too fast, 503 the platform could not be reached (try again - it is not "not found").
Parameters
- __namedParameters: {
      auth: string;
      platform: UsernameSocialPlatform;
      username: string;
  }
  - auth: string
  - platform: UsernameSocialPlatform
  - username: string
Returns Promise<WebResponse<{
    account: {
        created: boolean;
        dbId: string;
    };
    view: null | SocialAccountsView;
}>>
- Defined in src/classes/socials.ts:23

deleteSocial

deleteSocial(__namedParameters): Promise<WebResponse<null | SocialAccountsView>>
Unlink an account. Always allowed. Unlinking the primary makes the oldest remaining one primary.
Parameters
- __namedParameters: {
  accountId: string;
  auth: string;
  }
  - accountId: string
  - auth: string
Returns Promise<WebResponse<null | SocialAccountsView>>
- Defined in src/classes/socials.ts:39

getSocials

getSocials(__namedParameters): Promise<WebResponse<SocialAccountsView>>
The user's linked accounts per platform, with the limit and whether YouTube is available to them yet.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<SocialAccountsView>>
- Defined in src/classes/socials.ts:11

updateSocial

updateSocial(__namedParameters): Promise<WebResponse<null | SocialAccountsView>>
Make an account the platform's primary. 409 while the platform is locked (User Premium ended with extras).
Parameters
- __namedParameters: {
  accountId: string;
  auth: string;
  }
  - accountId: string
  - auth: string
Returns Promise<WebResponse<null | SocialAccountsView>>
- Defined in src/classes/socials.ts:31