Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutgoingFriendRequest

An outgoing friend request

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates info about an outgoing friend request

    Parameters

    • account: LoggedInUser

      The account that sent the friend request

    • creator: UserCreator

      The creator of the user the account belongs to

    • rawData: string

      The raw data to parse

    Returns OutgoingFriendRequest

Properties

from

from: true extends true ? LoggedInUser : StatlessSearchedUser

Who the friend request is from

id

id: number

The friend request ID

msg

msg: string

The message with the friend request

read

read: boolean

Whether the friend request has been read yet

to

to: true extends true ? StatlessSearchedUser : LoggedInUser

Who the friend request is to

Methods

cancel

  • cancel(): Promise<boolean>

  • Cancels a friend request, deleting it from the server

    async

    Returns Promise<boolean>

    Whether the cancellation was successful

Generated using TypeDoc