Class ServerMember

Server Member Class

Hierarchy

ServerMember

Index

Constructors

constructor

new ServerMember(collection: ServerMemberCollection, id: {
server: string;
user: string;
}): ServerMember
Construct Server Member
Parameters
- collection: ServerMemberCollection
  
  Collection
- id: {
  server: string;
  user: string;
  }
  
  Id
  - server: string
    
    Description
    Server Id
  - user: string
    
    Description
    User Id
Returns ServerMember
- Defined in src/classes/ServerMember.ts:35

Properties

`Private` `Readonly` #collection

#collection: ServerMemberCollection

`Readonly` id

id: {
server: string;
user: string;
}

Type declaration

server: string

Description
Server Id
user: string

Description
User Id

Accessors

$exists

get $exists(): boolean
Whether this object exists

Returns boolean
- Defined in src/classes/ServerMember.ts:51

animatedAvatarURL

get animatedAvatarURL(): undefined | string
URL to the member's animated avatar

Returns undefined | string
- Defined in src/classes/ServerMember.ts:215

avatar

get avatar(): undefined | File
Avatar

Returns undefined | File
- Defined in src/classes/ServerMember.ts:86

avatarURL

get avatarURL(): undefined | string
URL to the member's avatar

Returns undefined | string
- Defined in src/classes/ServerMember.ts:206

displayName

get displayName(): undefined | string
Display name

Returns undefined | string
- Defined in src/classes/ServerMember.ts:199

hoistedRole

get hoistedRole(): null | {
    colour?: null | string;
    hoist?: boolean;
    id: string;
    name?: string;
    permissions?: {
        a: number;
        d: number;
    };
    rank?: number;
}
Member's currently hoisted role.

Returns null | {
    colour?: null | string;
    hoist?: boolean;
    id: string;
    name?: string;
    permissions?: {
        a: number;
        d: number;
    };
    rank?: number;
}
- Defined in src/classes/ServerMember.ts:122

joinedAt

get joinedAt(): Date
When this user joined the server

Returns Date
- Defined in src/classes/ServerMember.ts:72

nickname

get nickname(): undefined | string
Nickname

Returns undefined | string
- Defined in src/classes/ServerMember.ts:79

orderedRoles

get orderedRoles(): {
    colour?: null | string;
    hoist?: boolean;
    id: string;
    name?: string;
    permissions?: {
        a: number;
        d: number;
    };
    rank?: number;
}[]
Ordered list of roles for this member, from lowest to highest priority.

Returns {
    colour?: null | string;
    hoist?: boolean;
    id: string;
    name?: string;
    permissions?: {
        a: number;
        d: number;
    };
    rank?: number;
}[]
- Defined in src/classes/ServerMember.ts:107

ranking

get ranking(): number
Member's ranking Smaller values are ranked as higher priority

Returns number
- Defined in src/classes/ServerMember.ts:147

roleColour

get roleColour(): undefined | null | string
Member's current role colour.

Returns undefined | null | string
- Defined in src/classes/ServerMember.ts:134

roles

get roles(): string[]
List of role IDs

Returns string[]
- Defined in src/classes/ServerMember.ts:93

server

get server(): undefined | Server
Server this member belongs to

Returns undefined | Server
- Defined in src/classes/ServerMember.ts:58

timeout

get timeout(): undefined | Date
Time at which timeout expires

Returns undefined | Date
- Defined in src/classes/ServerMember.ts:100

user

get user(): undefined | User
User corresponding to this member

Returns undefined | User
- Defined in src/classes/ServerMember.ts:65

Methods

ban

ban(options: {
reason?: null | string;
}): Promise<void>
Ban this member from the server
Parameters
- options: {
  reason?: null | string;
  }
  
  Ban options
  - Optional reason?: null | string
    
    Description
    Ban reason
Returns Promise<void>
- Defined in src/classes/ServerMember.ts:237

edit

edit(data: {
    avatar?: null | string;
    nickname?: null | string;
    remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[];
    roles?: null | string[];
    timeout?: null | string;
}): Promise<void>
Edit a member
Parameters
- data: {
      avatar?: null | string;
      nickname?: null | string;
      remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[];
      roles?: null | string[];
      timeout?: null | string;
  }
  
  Changes
  - Optional avatar?: null | string
    
    Description
    Attachment Id to set for avatar
  - Optional nickname?: null | string
    
    Description
    Member nickname
  - Optional remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[]
    
    Description
    Fields to remove from channel object
  - Optional roles?: null | string[]
    
    Description
    Array of role ids
  - Optional timeout?: null | string
    
    Description
    Timestamp this member is timed out until
Returns Promise<void>
- Defined in src/classes/ServerMember.ts:226

getPermissions

getPermissions(target: Channel | Server): number
Get the permissions that this member has against a certain object

Returns
Permissions that this member has
Parameters
- target: Channel | Server
  
  Target object to check permissions against
Returns number
- Defined in src/classes/ServerMember.ts:165

hasPermission

hasPermission(target: Channel | Server, ...permission: ("Video" | "Masquerade" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]): boolean
Check whether a member has a certain permission against a certain object

Returns
Whether the member has this permission
Parameters
- target: Channel | Server
  
  Target object to check permissions against
- Rest ...permission: ("Video" | "Masquerade" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]
  
  Permission names to check for
Returns boolean
- Defined in src/classes/ServerMember.ts:177

inferiorTo

inferiorTo(target: ServerMember): boolean
Checks whether the target member has a higher rank than this member.

Returns
Whether this member is inferior to the target
Parameters
- target: ServerMember
  
  The member to compare against
Returns boolean
- Defined in src/classes/ServerMember.ts:192

kick

kick(): Promise<void>
Kick this member from the server

Returns Promise<void>
- Defined in src/classes/ServerMember.ts:244

toString

toString(): string
Convert to string

Returns
String

Returns string
- Defined in src/classes/ServerMember.ts:44

Class ServerMember

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

collection: ServerMemberCollection

id: { server: string; user: string; }

server: string

Description

user: string

Description

Returns ServerMember

Properties

Private Readonly #collection

Readonly id

Type declaration

server: string

Description

user: string

Description

Accessors

$exists

Returns boolean

animatedAvatarURL

Returns undefined | string

avatar

Returns undefined | File

avatarURL

Returns undefined | string

displayName

Returns undefined | string

hoistedRole

Returns null | { colour?: null | string; hoist?: boolean; id: string; name?: string; permissions?: { a: number; d: number; }; rank?: number; }

joinedAt

Returns Date

nickname

Returns undefined | string

orderedRoles

Returns { colour?: null | string; hoist?: boolean; id: string; name?: string; permissions?: { a: number; d: number; }; rank?: number; }[]

ranking

Returns number

roleColour

Returns undefined | null | string

roles

Returns string[]

server

Returns undefined | Server

timeout

Returns undefined | Date

user

Returns undefined | User

Methods

ban

Parameters

options: { reason?: null | string; }

Optional reason?: null | string

Description

Returns Promise<void>

edit

Parameters

data: { avatar?: null | string; nickname?: null | string; remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[]; roles?: null | string[]; timeout?: null | string; }

Optional avatar?: null | string

Description

Optional nickname?: null | string

Description

Optional remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[]

Description

Optional roles?: null | string[]

Description

Optional timeout?: null | string

Description

Returns Promise<void>

getPermissions

Returns

Parameters

id: {
server: string;
user: string;
}

`Private` `Readonly` #collection

`Readonly` id

Returns null | {
colour?: null | string;
hoist?: boolean;
id: string;
name?: string;
permissions?: {
a: number;
d: number;
};
rank?: number;
}

Returns {
colour?: null | string;
hoist?: boolean;
id: string;
name?: string;
permissions?: {
a: number;
d: number;
};
rank?: number;
}[]

options: {
reason?: null | string;
}

`Optional` reason?: null | string

data: {
avatar?: null | string;
nickname?: null | string;
remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[];
roles?: null | string[];
timeout?: null | string;
}

`Optional` avatar?: null | string

`Optional` nickname?: null | string

`Optional` remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[]

`Optional` roles?: null | string[]

`Optional` timeout?: null | string