Class Relationship

Constructors

constructor

Properties

avatar dms dmsLoaded id ready relationshipID username lazyLoadDms

Methods

dm invite loadDms markAsRead

Constructors

constructor

  • new Relationship(options, social, client): Classes.Relationship

  • Parameters

    • options: {
          avatar: number;
          id: string;
          relationshipID: string;
          username: string;
      }
      • avatar: number
      • id: string
      • relationshipID: string
      • username: string
    • social: Classes.Social
    • client: Client

    Returns Classes.Relationship

Properties

avatar

avatar: number

Avatar ID of the account on the other side of the relationship

dms

dms: DM[]

The DMs that have been sent and received. You may need to call loadDms to populate this information

dmsLoaded

dmsLoaded: boolean = false

Whether or not the dms have been loaded

id

id: string

ID of the account on the other side of the relationsihp

ready

ready: Promise<void>

Promise that resolves when the dms have been loaded. This will not resovle if Relationship.lazyLoadDms is set to true.

relationshipID

relationshipID: string

ID of the relationship

username

username: string

Username of the account on the other side of the relationship

StaticlazyLoadDms

lazyLoadDms: boolean = true

Methods

dm

  • dm(content): Promise<void>

  • Send a dm to the user.

    Parameters

    • content: string

    Returns Promise<void>

    Example

    relationship.dm("Hello!");

invite

  • invite(): void

  • Invite the user to a game

    Returns void

    Example

    relationship.invite();

loadDms

  • loadDms(): Promise<DM[]>

  • Load the DMs for this relationship

    Returns Promise<DM[]>

    Example

    await relationship.loadDms();

markAsRead

  • markAsRead(): void

  • Mark the dms as read

    Returns void

    Example

    relationship.markAsRead();

Settings

Member Visibility

On This Page

Constructors
Properties
Methods