Class Social

blocked

config

friends

notifications

online

other

StaticdefaultConfig

block

• block(userID: string): Promise<false | undefined>

  Block a user

  Parameters

  • userID: string

  Returns Promise<false | undefined>

  false if the user is already blocked, true otherwise

  Example

  await client.social.block(await client.social.resolve('halp'));
  Copy

destroy

• destroy(): void
  Internal

  Returns void

dm

• dm(userID: string, message: string): Promise<string | void | DM>

  Send a message to a specified user (based on id). Returns Promise<"you.fail" | "they.fail" | "you.ban" | "they.ban"> if suppressDMErrors is true and an error (social.dm.fail) is thrown.

  Parameters

  • userID: string
  • message: string

  Returns Promise<string | void | DM>

  Example

  await client.social.dm(await client.social.resolve('halp'), 'what\'s up?');
  Copy

friend

• friend(userID: string): Promise<boolean>

  Send a user a friend request

  Parameters

  • userID: string

  Returns Promise<boolean>

  false if the user is already friended, true otherwise

  Example

  await client.social.friend(await client.social.resolve('halp'));
  Copy

  Throws

  If an error occurs (such as the user has blocked the client, etc)

get

• get(target: string): Classes.Relationship | null

  Get a user + social data from the list of users and pending friends (OTHER tab in TETR.IO)

  Parameters

  • target: string

  Returns Classes.Relationship | null

  Example

  const user = await client.social.get('halp')
  Copy

  Example

  const user = await client.social.get('646f633d276f42a80ba44304');
  Copy

  Example

  const user = await client.social.get({ username: 'halp' });
  Copy

  Example

  const user = await client.social.get({ id: '646f633d276f42a80ba44304 });
  Copy

  Example

  // You can then use the object to read user data and interact with the user
  await user.dm('wanna play?');
  await user.invite();
  Copy

• get(target: { id: string }): Classes.Relationship | null

  Get a user + social data from the list of users and pending friends (OTHER tab in TETR.IO)

  Parameters

  • target: { id: string }

  Returns Classes.Relationship | null

  Example

  const user = await client.social.get('halp')
  Copy

  Example

  const user = await client.social.get('646f633d276f42a80ba44304');
  Copy

  Example

  const user = await client.social.get({ username: 'halp' });
  Copy

  Example

  const user = await client.social.get({ id: '646f633d276f42a80ba44304 });
  Copy

  Example

  // You can then use the object to read user data and interact with the user
  await user.dm('wanna play?');
  await user.invite();
  Copy

• get(target: { username: string }): Classes.Relationship | null

  Get a user + social data from the list of users and pending friends (OTHER tab in TETR.IO)

  Parameters

  • target: { username: string }

  Returns Classes.Relationship | null

  Example

  const user = await client.social.get('halp')
  Copy

  Example

  const user = await client.social.get('646f633d276f42a80ba44304');
  Copy

  Example

  const user = await client.social.get({ username: 'halp' });
  Copy

  Example

  const user = await client.social.get({ id: '646f633d276f42a80ba44304 });
  Copy

  Example

  // You can then use the object to read user data and interact with the user
  await user.dm('wanna play?');
  await user.invite();
  Copy

invite

• invite(userID: string): Promise<void>

  Invite a user to your room. Note: the TETR.IO api doesn't send a response for a successful invite. Instead, Triangle.js waits 100 milliseconds for an error, and resolves/returns if there is no error.

  Parameters

  • userID: string

  Returns Promise<void>

  Example

  await client.social.invite(await client.social.resolve('halp'));
  Copy

markNotificationsAsRead

• markNotificationsAsRead(): void

  Marks all notifications as read

  Returns void

  Example

  client.social.markNotificationsAsRead();
  Copy

resolve

• resolve(username: string): Promise<string>

  Get the user id given a username

  Parameters

  • username: string

  Returns Promise<string>

snapshot

• snapshot(): SocialSnapshot

  For internal use only. See client.snapshot()

  Returns SocialSnapshot

status

• status(status: Status, detail?: String | Detail): void

  Set the client's status

  Parameters

  • status: Status
  • detail: String | Detail = ""

  Returns void

  Example

  client.social.status('online', 'lobby:X-QP');
  Copy

unblock

• unblock(userID: string): Promise<void>

  Unblock a user. Note: unblocking a user will unfriend them if they are friended.

  Parameters

  • userID: string

  Returns Promise<void>

  false if the user is not unblocked, true otherwise

  Example

  await client.social.unblock(await client.social.resolve('halp'));
  Copy

unfriend

• unfriend(userID: string): Promise<boolean>

  Unfriend a user. Note: unfriending a user will unblock them if they are blocked.

  Parameters

  • userID: string

  Returns Promise<boolean>

  false if the user is not unfriended, true otherwise

  Example

  await client.social.unfriend(await client.social.resolve('halp'));
  Copy

who

• who(id: string): Promise<Utils.APITypes.Users.User>

  Get a users' information based on their userid or username

  Parameters

  • id: string

  Returns Promise<Utils.APITypes.Users.User>

  Example

  const user = await client.social.who(await client.social.resolve('halp'));
  Copy

Staticcreate

• create(
      client: Client,
      config: Partial<Types.Social.Config>,
      initData: {
          notifications: Notification[];
          presences: {
              [userId: string]: {
                  detail: string;
                  invitable: boolean;
                  status: string;
              };
          };
          relationships: Types.Social.Relationship[];
          total_online: number;
      },
  ): Classes.Social

  Parameters

  • client: Client
  • config: Partial<Types.Social.Config>
  • initData: {
        notifications: Notification[];
        presences: {
            [userId: string]: {
                detail: string;
                invitable: boolean;
                status: string;
            };
        };
        relationships: Types.Social.Relationship[];
        total_online: number;
    }

  Returns Classes.Social

StaticfromSnapshot

• fromSnapshot(snapshot: SocialSnapshot, client: Client): Classes.Social

  For internal use only. See Client.fromSnapshot()

  Parameters

  • snapshot: SocialSnapshot
  • client: Client

  Returns Classes.Social