Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Relationship

Relationship Structure Used to describe a relationship with a user (only non-bots)

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysRelationship

client

client: ShardClient

id

id: string = ""

type

type: RelationshipTypes = RelationshipTypes.NONE

user

user: User

Accessors

isBlocked

  • get isBlocked(): boolean
  • Returns boolean

isFriend

  • get isFriend(): boolean
  • Returns boolean

isImplicit

  • get isImplicit(): boolean
  • Returns boolean

isNone

  • get isNone(): boolean
  • Returns boolean

isPendingIncoming

  • get isPendingIncoming(): boolean
  • Returns boolean

isPendingOutgoing

  • get isPendingOutgoing(): boolean
  • Returns boolean

shardId

  • get shardId(): number
  • Returns number

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

  • _setFromSnake(key: string, value: any): any
  • Parameters

    • key: string
    • value: any

    Returns any

difference

  • difference(key: string, value: any): [boolean, any]
  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

merge

mergeValue

  • mergeValue(key: string, value: any): void
  • Parameters

    • key: string
    • value: any

    Returns void

toJSON

  • toJSON(): object
  • Returns object

Generated using TypeDoc