Triangle.js Docs
    Preparing search index...

    Class Relationship

    Index

    Constructors

    constructor

    Properties

    avatar? dms dmsLoaded id ready relationshipID username lazyLoadDms

    Methods

    dm invite loadDms markAsRead snapshot fromSnapshot

    Constructors

    • Parameters

      • options: { avatar?: number; id: string; relationshipID: string; username: string }
      • social: Classes.Social
      • client: Client
      • lazyLoad: boolean = Relationship.lazyLoadDms

      Returns Classes.Relationship

    Properties

    avatar?: number

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

    dms: DM[]

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

    dmsLoaded: boolean = false

    Whether or not the dms have been loaded

    id: string

    ID of the account on the other side of the relationsihp

    ready: Promise<void>

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

    relationshipID: string

    ID of the relationship

    username: string

    Username of the account on the other side of the relationship

    lazyLoadDms: boolean = true

    Methods

    • Send a dm to the user.

      Parameters

      • content: string

      Returns Promise<void>

      relationship.dm("Hello!");

    • Invite the user to a game

      Returns void

      relationship.invite();

    • Load the DMs for this relationship

      Returns Promise<DM[]>

      await relationship.loadDms();

    • Mark the dms as read

      Returns void

      relationship.markAsRead();

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods