Class Relationship

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

Hierarchy

BaseStructure
- Relationship

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/relationship.ts:29
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Relationship

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Readonly client

client: ShardClient

id

id: string = ''

type

type: RelationshipTypes = ...

user

user: User

Accessors

isBlocked

get isBlocked(): boolean

- Defined in src/structures/relationship.ts:40
Returns boolean

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

isFriend

get isFriend(): boolean

- Defined in src/structures/relationship.ts:44
Returns boolean

isImplicit

get isImplicit(): boolean

- Defined in src/structures/relationship.ts:48
Returns boolean

isNone

get isNone(): boolean

- Defined in src/structures/relationship.ts:52
Returns boolean

isPendingIncoming

get isPendingIncoming(): boolean

- Defined in src/structures/relationship.ts:56
Returns boolean

isPendingOutgoing

get isPendingOutgoing(): boolean

- Defined in src/structures/relationship.ts:60
Returns boolean

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

clone

clone(): Relationship

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Relationship

difference

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

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

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

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides BaseStructure.mergeValue
- Defined in src/structures/relationship.ts:64
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc