hoshii / Exports / ServerMember

ServerMember

Represents a user

Hierarchy

• User

  ↳ ServerMember

Table of contents

Constructors

• constructor

Properties

• _data
• avatar
• banner
• bot
• client
• createdAt
• id
• isOwner
• joinedAt
• name
• nickname
• roleIDs
• serverID
• type

Accessors

• server
• user

Methods

• addGroup
• addRole
• award
• createBan
• edit
• getSocialLink
• remove
• removeBan
• removeGroup
• removeRole
• setXP
• toJSON
• update

Constructors

constructor

• new ServerMember(data, client, serverID)

Create a new ServerMember

Parameters

Name	Type	Description
data	RawServerMember	The raw data of the member
client	Client	The client
serverID	string	The ID of the server the member is in

Overrides

User.constructor

Defined in

lib/structures/ServerMember.ts:68

Properties

_data

• Private _data: RawServerMember

The raw data of the member

Defined in

lib/structures/ServerMember.ts:35

---

avatar

• avatar: string

The avatar of the user

Inherited from

User.avatar

Defined in

lib/structures/User.ts:38

---

banner

• banner: string

The banner of the user

Inherited from

User.banner

Defined in

lib/structures/User.ts:43

---

bot

• bot: boolean

Whether the user is a bot

Inherited from

User.bot

Defined in

lib/structures/User.ts:48

---

client

• client: Client

The bot client

Inherited from

User.client

Defined in

lib/structures/Base.ts:13

---

createdAt

• createdAt: Date

The date the user was created at

Inherited from

User.createdAt

Defined in

lib/structures/User.ts:53

---

id

• id: string

The ID of the item

Inherited from

User.id

Defined in

lib/structures/Base.ts:16

---

isOwner

• isOwner: boolean

Whether the member is the owner of the server

Defined in

lib/structures/ServerMember.ts:40

---

joinedAt

• joinedAt: Date

The date the member joined the server

Defined in

lib/structures/ServerMember.ts:45

---

name

• name: string

The name of the user

Inherited from

User.name

Defined in

lib/structures/User.ts:58

---

nickname

• nickname: string

The nickname of the member

Defined in

lib/structures/ServerMember.ts:50

---

roleIDs

• roleIDs: number[]

An array of role IDs the member has

Defined in

lib/structures/ServerMember.ts:55

---

serverID

• serverID: string

The ID of the server the member is in

Defined in

lib/structures/ServerMember.ts:60

---

type

• type: UserTypes

The type of the user

Inherited from

User.type

Defined in

lib/structures/User.ts:63

Accessors

server

• get server(): Server | Promise<Server>

The server the member is in

Returns

Server | Promise<Server>

Defined in

lib/structures/ServerMember.ts:88

---

user

• get user(): User

The user data of the member

Returns

User

Defined in

lib/structures/ServerMember.ts:98

Methods

addGroup

▸ addGroup(groupID): Promise<void>

Add a member to a group

Parameters

Name	Type	Description
groupID	string	The ID of the group

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:115

---

addRole

▸ addRole(roleID): Promise<void>

Add a role to a member

Parameters

Name	Type	Description
roleID	number	The ID of the role

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:124

---

award

▸ award(amount): Promise<number>

Award the member the built-in XP system

Parameters

Name	Type	Description
amount	number	The amount of XP to award

Returns

Promise<number>

Defined in

lib/structures/ServerMember.ts:133

---

createBan

▸ createBan(reason?): Promise<ServerMemberBan>

Create a ban for the member

Parameters

Name	Type	Description
reason?	string	The reason for the ban

Returns

Promise<ServerMemberBan>

Defined in

lib/structures/ServerMember.ts:141

---

edit

▸ edit(options): Promise<void>

Edit the member

Parameters

Name	Type	Description
options	ServerMemberEditOptions	The options to edit the member with

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:154

---

getSocialLink

▸ getSocialLink(socialMediaName): Promise<SocialLink>

Get the social link of the member

Parameters

Name	Type	Description
socialMediaName	string	The name of the social media

Returns

Promise<SocialLink>

Defined in

lib/structures/ServerMember.ts:163

---

remove

▸ remove(): Promise<void>

Remove the member from the server

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:175

---

removeBan

▸ removeBan(): Promise<void>

Remove a member ban

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:183

---

removeGroup

▸ removeGroup(groupID): Promise<void>

Remove a member from a group

Parameters

Name	Type	Description
groupID	string	The ID of the group

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:192

---

removeRole

▸ removeRole(roleID): Promise<void>

Remove a role from a member

Parameters

Name	Type	Description
roleID	number	The ID of the role

Returns

Promise<void>

Defined in

lib/structures/ServerMember.ts:201

---

setXP

▸ setXP(total): Promise<number>

Set the member XP using the built-in XP system

Parameters

Name	Type	Description
total	number	The total XP to set

Returns

Promise<number>

Defined in

lib/structures/ServerMember.ts:214

---

toJSON

▸ toJSON(): ServerMemberData

Returns the JSON representation of the item

Returns

ServerMemberData

Overrides

User.toJSON

Defined in

lib/structures/ServerMember.ts:218

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawServerMember

Returns

void

Overrides

User.update

Defined in

lib/structures/ServerMember.ts:229