Class ServerMember

constructor

• new ServerMember(collection, id): 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

Readonly id

$exists

• get $exists(): boolean

• Whether this object exists

  Returns boolean

animatedAvatarURL

• get animatedAvatarURL(): undefined | string

• URL to the member's animated avatar

  Returns undefined | string

avatar

• get avatar(): undefined | File

• Avatar

  Returns undefined | File

avatarURL

• get avatarURL(): undefined | string

• URL to the member's avatar

  Returns undefined | string

displayName

• get displayName(): undefined | string

• Display name

  Returns undefined | string

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;
  }

joinedAt

• get joinedAt(): Date

• When this user joined the server

  Returns Date

nickname

• get nickname(): undefined | string

• Nickname

  Returns undefined | string

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;
  }[]

ranking

• get ranking(): number

• Member's ranking Smaller values are ranked as higher priority

  Returns number

roleColour

• get roleColour(): undefined | null | string

• Member's current role colour.

  Returns undefined | null | string

roles

• get roles(): string[]

• List of role IDs

  Returns string[]

server

• get server(): undefined | Server

• Server this member belongs to

  Returns undefined | Server

timeout

• get timeout(): undefined | Date

• Time at which timeout expires

  Returns undefined | Date

user

• get user(): undefined | User

• User corresponding to this member

  Returns undefined | User

ban

• ban(options): 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>

edit

• edit(data): 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>

getPermissions

• getPermissions(target): number

• Get the permissions that this member has against a certain object

  Parameters

  • target: Channel | Server

    Target object to check permissions against

  Returns number

  Permissions that this member has

hasPermission

• hasPermission(target, ...permission): boolean

• Check whether a member has a certain permission against a certain object

  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

  Whether the member has this permission

inferiorTo

• inferiorTo(target): boolean

• Checks whether the target member has a higher rank than this member.

  Parameters

  • target: ServerMember

    The member to compare against

  Returns boolean

  Whether this member is inferior to the target

kick

• kick(): Promise<void>

• Kick this member from the server

  Returns Promise<void>

toString

• toString(): string

• Convert to string

  Returns string

  String