hoshii / Exports / Server

Server

Represents a server

Hierarchy

• Base<string>

  ↳ Server

Table of contents

Constructors

• constructor

Properties

• _clientMember
• about
• avatar
• banner
• channels
• client
• creaetdAt
• defaultChannelID
• id
• isVerified
• members
• name
• ownerID
• timezone
• type
• url

Accessors

• owner

Methods

• createMemberBan
• removeMemberBan
• toJSON
• update

Constructors

constructor

• new Server(data, client)

Create a new Server

Parameters

Name	Type	Description
data	RawServer	The raw data of the server
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/Server.ts:123

Properties

_clientMember

• Private Optional _clientMember: ServerMember

The client member of the server

Defined in

lib/structures/Server.ts:46

---

about

• Optional about: string

The about info of the server

Defined in

lib/structures/Server.ts:51

---

avatar

• Optional avatar: string

The avatar of the server

Defined in

lib/structures/Server.ts:56

---

banner

• Optional banner: string

The banner of the server

Defined in

lib/structures/Server.ts:61

---

channels

• channels: TypedCollection<string, RawServerChannel, AnyChannel, []>

A collection of cached channels

Defined in

lib/structures/Server.ts:66

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

creaetdAt

• creaetdAt: Date

The date the server was created at

Defined in

lib/structures/Server.ts:71

---

defaultChannelID

• Optional defaultChannelID: string

The ID of the default channel

Defined in

lib/structures/Server.ts:76

---

id

• id: string

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

isVerified

• isVerified: boolean

Whether the server is verified

Defined in

lib/structures/Server.ts:81

---

members

• members: TypedCollection<string, RawServerMember, ServerMember, [serverID: string]>

A collection of cached server members

Defined in

lib/structures/Server.ts:86

---

name

• name: string

The name of the server

Defined in

lib/structures/Server.ts:96

---

ownerID

• ownerID: string

The ID of the owner of the server

Defined in

lib/structures/Server.ts:101

---

timezone

• Optional timezone: string

The timezone of the server

Defined in

lib/structures/Server.ts:106

---

type

• Optional type: ServerCategories

The type of the server

Defined in

lib/structures/Server.ts:111

---

url

• Optional url: string

The URL of the server

Defined in

lib/structures/Server.ts:116

Accessors

owner

• get owner(): User | ServerMember | Promise<ServerMember>

The owner of the server

Returns

User | ServerMember | Promise<ServerMember>

Defined in

lib/structures/Server.ts:145

Methods

createMemberBan

▸ createMemberBan(memberID, reason?): Promise<ServerMemberBan>

Create a member ban

Parameters

Name	Type	Description
memberID	string	The ID of the member
reason?	string	The reason for the ban

Returns

Promise<ServerMemberBan>

Defined in

lib/structures/Server.ts:159

---

removeMemberBan

▸ removeMemberBan(memberID): Promise<void>

Remove a member ban

Parameters

Name	Type	Description
memberID	string	The ID of the member

Returns

Promise<void>

Defined in

lib/structures/Server.ts:171

---

toJSON

▸ toJSON(): ServerData

Returns the JSON representation of the item

Returns

ServerData

Overrides

Base.toJSON

Defined in

lib/structures/Server.ts:175

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawServer

Returns

void

Overrides

Base.update

Defined in

lib/structures/Server.ts:192