Documentation/detritus-client/Structures

Relationshipclass

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

On this page

Overview
Constructor1
Properties4
Accessors8
Methods13

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

import { Structures } from 'detritus-client';

Structures.Relationship;

Hierarchy

StructureBaseStructureRelationship

9 properties1 method15 inheritedsrc/structures/relationship.ts:25

Constructor

new Relationship

src/structures/relationship.ts:32

new Relationship(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

client

ShardClient

readonly

Inherited from BaseStructure.client

string

Default ''

type

RelationshipTypes

Default RelationshipTypes.NONE

user

User

Accessors

isBlocked

boolean

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isFriend

boolean

get

isImplicit

boolean

get

isNone

boolean

get

isPendingIncoming

boolean

get

isPendingOutgoing

boolean

get

shardId

number

get

Inherited from BaseStructure.shardId

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

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

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/relationship.ts:65

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON