Class: ServerEndpoint

Defined in: endpoints/server.ts:26

Constructors

Constructor

new ServerEndpoint(client): ServerEndpoint;

Defined in: endpoints/server.ts:27

Parameters

Parameter	Type
client	RESTClient

Returns

ServerEndpoint

Methods

acceptInvite()

acceptInvite(inviteId): Promise<IAcceptServerInviteResponse>;

Defined in: endpoints/server.ts:164

join the server an invite is for; only its recipient can

Parameters

Parameter	Type
inviteId	number

Returns

Promise<IAcceptServerInviteResponse>

---

createInviteLink()

createInviteLink(serverId, params): Promise<IServerInviteLinkResponse>;

Defined in: endpoints/server.ts:94

Make a link anyone signed in can join with. expiresInSeconds null never expires; maxUses null has no limit.

Parameters

Parameter	Type
serverId	number
params	{ expiresInSeconds: number | null; maxUses: number | null; }
params.expiresInSeconds	number | null
params.maxUses	number | null

Returns

Promise<IServerInviteLinkResponse>

---

createServer()

createServer(params): Promise<ICreateServerResponse>;

Defined in: endpoints/server.ts:33

Parameters

Parameter	Type
params	{ color?: string; description?: string; name: string; }
params.color?	string
params.description?	string
params.name	string

Returns

Promise<ICreateServerResponse>

---

declineInvite()

declineInvite(inviteId): Promise<IDeclineServerInviteResponse>;

Defined in: endpoints/server.ts:169

turn an invite down, which deletes it

Parameters

Parameter	Type
inviteId	number

Returns

Promise<IDeclineServerInviteResponse>

---

deleteServer()

deleteServer(serverId): Promise<IDeleteServerResponse>;

Defined in: endpoints/server.ts:73

Delete a server and everything in it: channels, messages, roles, members, bans and invites. Only its owner (or an instance admin) can, and there is no undo.

Parameters

Parameter	Type
serverId	number

Returns

Promise<IDeleteServerResponse>

---

getAuditLog()

getAuditLog(serverId, params?): Promise<IAuditLogResponse>;

Defined in: endpoints/server.ts:126

newest first; pass the last entry's id as before for the next page

Parameters

Parameter	Type
serverId	number
params?	{ action?: | "server_update" | "ownership_transfer" | "channel_create" | "channel_update" | "channel_delete" | "channel_overrides_update" | "category_create" | "category_update" | "category_delete" | "category_overrides_update" | "role_create" | "role_update" | "role_delete" | "member_roles_update" | "member_nickname_update" | "member_kick" | "member_ban" | "member_unban" | "ban_note_update" | "member_timeout" | "member_timeout_remove" | "member_join_link" | "invite_link_create" | "invite_link_revoke" | "badge_create" | "badge_update" | "badge_delete" | "badge_assign" | "badge_unassign" | "soundboard_create" | "soundboard_update" | "soundboard_delete" | "bot_create" | "bot_update" | "bot_rotate" | "bot_delete"; actorId?: number; before?: number; limit?: number; }
params.action?	| "server_update" | "ownership_transfer" | "channel_create" | "channel_update" | "channel_delete" | "channel_overrides_update" | "category_create" | "category_update" | "category_delete" | "category_overrides_update" | "role_create" | "role_update" | "role_delete" | "member_roles_update" | "member_nickname_update" | "member_kick" | "member_ban" | "member_unban" | "ban_note_update" | "member_timeout" | "member_timeout_remove" | "member_join_link" | "invite_link_create" | "invite_link_revoke" | "badge_create" | "badge_update" | "badge_delete" | "badge_assign" | "badge_unassign" | "soundboard_create" | "soundboard_update" | "soundboard_delete" | "bot_create" | "bot_update" | "bot_rotate" | "bot_delete"
params.actorId?	number
params.before?	number
params.limit?	number

Returns

Promise<IAuditLogResponse>

---

getInvitableServers()

getInvitableServers(userId): Promise<IInvitableServersResponse>;

Defined in: endpoints/server.ts:154

servers the current user could add userId to, and those userId is banned from

Parameters

Parameter	Type
userId	number

Returns

Promise<IInvitableServersResponse>

---

getInviteLink()

getInviteLink(code, instance?): Promise<IInviteLinkPreviewResponse>;

Defined in: endpoints/server.ts:112

instance is the domain of another instance whose server the invite is to; omit it for this one

Parameters

Parameter	Type
code	string
instance?	string | null

Returns

Promise<IInviteLinkPreviewResponse>

---

getServer()

getServer(serverId): Promise<ISingleServerResponse>;

Defined in: endpoints/server.ts:37

Parameters

Parameter	Type
serverId	number

Returns

Promise<ISingleServerResponse>

---

getServerChannels()

getServerChannels(serverId): Promise<IServerChannelsResponse>;

Defined in: endpoints/server.ts:59

Parameters

Parameter	Type
serverId	number

Returns

Promise<IServerChannelsResponse>

---

getUserServers()

getUserServers(): Promise<IUserServersResponse>;

Defined in: endpoints/server.ts:29

Returns

Promise<IUserServersResponse>

---

inviteUserToServer()

inviteUserToServer(serverId, params): Promise<IInviteUserToServerResponse>;

Defined in: endpoints/server.ts:146

Add someone to a server outright, with nothing for them to accept - what an instant invite does. sendInvite asks them first.

Parameters

Parameter	Type
serverId	number
params	{ userId?: number; username?: string; }
params.userId?	number
params.username?	string

Returns

Promise<IInviteUserToServerResponse>

---

joinWithInviteLink()

joinWithInviteLink(code, instance?): Promise<IJoinInviteLinkResponse>;

Defined in: endpoints/server.ts:118

joining a server on another instance (instance) keeps a copy of it on this one

Parameters

Parameter	Type
code	string
instance?	string | null

Returns

Promise<IJoinInviteLinkResponse>

---

kickMember()

kickMember(serverId, userId): Promise<IKickServerMemberResponse>;

Defined in: endpoints/server.ts:138

Parameters

Parameter	Type
serverId	number
userId	number

Returns

Promise<IKickServerMemberResponse>

---

leaveServer()

leaveServer(serverId): Promise<ILeaveServerResponse>;

Defined in: endpoints/server.ts:64

the owner cannot leave; they delete the server instead

Parameters

Parameter	Type
serverId	number

Returns

Promise<ILeaveServerResponse>

---

listInviteLinks()

listInviteLinks(serverId): Promise<IServerInviteLinksResponse>;

Defined in: endpoints/server.ts:102

links still usable: everyone's with manage_invites, otherwise your own

Parameters

Parameter	Type
serverId	number

Returns

Promise<IServerInviteLinksResponse>

---

revokeInviteLink()

revokeInviteLink(serverId, code): Promise<IApiResponse>;

Defined in: endpoints/server.ts:106

Parameters

Parameter	Type
serverId	number
code	string

Returns

Promise<IApiResponse>

---

sendInvite()

sendInvite(serverId, userId): Promise<ISendServerInviteResponse>;

Defined in: endpoints/server.ts:159

invite a friend: they get a direct message they can accept or decline

Parameters

Parameter	Type
serverId	number
userId	number

Returns

Promise<ISendServerInviteResponse>

---

setNickname()

setNickname(
   serverId, 
   userId, 
   nickname
): Promise<ISetNicknameResponse>;

Defined in: endpoints/server.ts:86

set a member's nickname here, or null to go back to their username

Parameters

Parameter	Type
serverId	number
userId	number
nickname	string | null

Returns

Promise<ISetNicknameResponse>

---

transferOwnership()

transferOwnership(serverId, userId): Promise<IApiResponse>;

Defined in: endpoints/server.ts:81

Hand the server to another member. Only the owner can; they keep the Admin role, and can then leave without the server going with them.

Parameters

Parameter	Type
serverId	number
userId	number

Returns

Promise<IApiResponse>

---

updateServer()

updateServer(serverId, params): Promise<IUpdateServerResponse>;

Defined in: endpoints/server.ts:41

Parameters

Parameter	Type	Description
serverId	number	-
params	{ afkTimeoutSeconds?: number; banner?: number | null; calendarsEnabled?: boolean; color?: string | null; description?: string | null; icon?: number | null; name?: string; welcomeChannelId?: number | null; }	-
params.afkTimeoutSeconds?	number	-
params.banner?	number | null	-
params.calendarsEnabled?	boolean	Enable this server's single shared calendar. Disabled by default.
params.color?	string | null	-
params.description?	string | null	-
params.icon?	number | null	-
params.name?	string	-
params.welcomeChannelId?	number | null	One text channel belonging to this server, or null to disable welcome messages.

Returns

Promise<IUpdateServerResponse>