Class Member

Index

Constructors

Properties

client joinedAt nickname? owner? roleIds user

Methods

addRole ban fetchAllRoles removeRole unban

Constructors

constructor

new Member(data: ServerMemberPayload, client: Client): Member
Parameters
- data: ServerMemberPayload
- client: Client
Returns Member
- Defined in src/structures/Member.ts:17

Properties

client

client: Client

joinedAt

joinedAt: Date

The date when the member joined.

`Optional`nickname

nickname?: string

The nickname of the member.

`Optional`owner

owner?: boolean

Whether the member is the server owner.

roleIds

roleIds: number[]

The IDs of the member's roles.

user

user: User

The user info of the member.

Methods

addRole

addRole(serverId: string, roleId: number): Promise<void>
Add a role to this Guilded member.
Parameters
- serverId: string
  The ID of the Guilded server.
- roleId: number
  The ID of the Guilded role.
Returns Promise<void>
- Defined in src/structures/Member.ts:30

ban

ban(serverId: string, reason?: string): Promise<Ban>
Ban a member from this Guilded server.
Parameters
- serverId: string
- Optionalreason: string
Returns Promise<Ban>
- Defined in src/structures/Member.ts:52

fetchAllRoles

fetchAllRoles(serverId: string): Promise<number[]>
Fetch all roles within this Guilded member.
Parameters
- serverId: string
  The ID of the Guilded server.
Returns Promise<number[]>
- Defined in src/structures/Member.ts:47

removeRole

removeRole(serverId: string, roleId: number): Promise<void>
Remove a role from this Guilded member.
Parameters
- serverId: string
  The ID of the Guilded server.
- roleId: number
  The ID of the Guilded role.
Returns Promise<void>
- Defined in src/structures/Member.ts:39

unban

unban(serverId: string): Promise<void>
Unban a member from this Guilded server.
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/structures/Member.ts:57