Class ServerMemberManager

Hierarchy (View Summary)

BaseManager<ServerMember, Member>
- ServerMemberManager

Index

Constructors

constructor

new ServerMemberManager(server: Server): ServerMemberManager
Parameters
- server: Server
Returns ServerMemberManager
Overrides BaseManager.constructor
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:15

Properties

`Readonly`cache

cache: Map<string, ServerMember> = ...

Insertion ordered cache of items this manager holds.

holds

holds: typeof ServerMember = ServerMember

Holds

Holds: any

`Static`defaultMaxSize

defaultMaxSize: number = -1

Shared default max size for all managers (can be changed globally).

Methods

_add

_add(
    raw: {
        _id: { server: string; user: string };
        avatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        joined_at: string;
        nickname?: null
        | string;
        roles?: string[];
        timeout?: null | string;
    },
): ServerMember
Adds a raw object to the cache, constructing the holdable class. Automatically evicts oldest entries if the max size is exceeded.
Parameters
- raw: {
      _id: { server: string; user: string };
      avatar?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
      joined_at: string;
      nickname?: null
      | string;
      roles?: string[];
      timeout?: null | string;
  }
  - _id: { server: string; user: string }
    Description
    Unique member id
    
    server: string
    Description
    Server Id
    
    user: string
    Description
    User Id
  - Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Avatar attachment
  - joined_at: string
    Description
    Time at which this user joined the server
  - Optionalnickname?: null | string
    Description
    Member's nickname
  - Optionalroles?: string[]
    Description
    Member's roles
  - Optionaltimeout?: null | string
    Description
    Timestamp this member is timed out until
Returns ServerMember
Inherited from BaseManager._add
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:26

_remove

_remove(id: string): void
Remove an entry by id.
Parameters
- id: string
Returns void
Inherited from BaseManager._remove
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:35

ban

ban(member: ServerMemberResolvable, reason?: string): Promise<void>
ban selected member in the server
Parameters
- member: ServerMemberResolvable
  The member to ban
- Optionalreason: string
  the reason for the ban
Returns Promise<void>
A promise that resolves when the member is banned
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:47

edit

edit(
member: ServerMemberResolvable,
options: EditServerMemberOptions,
): Promise<void>
edit selected member in the server
Parameters
- member: ServerMemberResolvable
  The member to edit
- options: EditServerMemberOptions
  The options to edit the member with
  - Optionalavatar?: string
  - Optionalnickname?: string
  - Optionalroles?: string[]
Returns Promise<void>
A promise that resolves when the member is edited
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:28

fetch

fetch(member: ServerMemberResolvable): Promise<ServerMember>
fetch a member from the server
Parameters
- member: ServerMemberResolvable
  The member to fetch
Returns Promise<ServerMember>
A promise that resolves with the fetched member
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:88
fetch(): Promise<Map<string, ServerMember>>
fetch a member from the server

Returns Promise<Map<string, ServerMember>>
A promise that resolves with the fetched member
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:89

kick

kick(member: ServerMemberResolvable): Promise<void>
kick selected member in the server
Parameters
- member: ServerMemberResolvable
  The member to kick
Returns Promise<void>
A promise that resolves when the member is kicked
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:62

resolve

resolve(resolvable: ServerMember): null | ServerMember
Parameters
- resolvable: ServerMember
Returns null | ServerMember
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:64
resolve(
    resolvable:
        | string
        | {
            _id: { server: string; user: string };
            avatar?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            joined_at: string;
            nickname?: null
            | string;
            roles?: string[];
            timeout?: null | string;
        },
): null
| ServerMember
Parameters
- resolvable:
      | string
      | {
          _id: { server: string; user: string };
          avatar?:
              | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
          joined_at: string;
          nickname?: null
          | string;
          roles?: string[];
          timeout?: null | string;
      }
  - string
  - {
        _id: { server: string; user: string };
        avatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        joined_at: string;
        nickname?: null
        | string;
        roles?: string[];
        timeout?: null | string;
    }
    _id: { server: string; user: string }
    Description
    Unique member id
    
    server: string
    Description
    Server Id
    
    user: string
    Description
    User Id
    
    Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Avatar attachment
    
    joined_at: string
    Description
    Time at which this user joined the server
    
    Optionalnickname?: null | string
    Description
    Member's nickname
    
    Optionalroles?: string[]
    Description
    Member's roles
    
    Optionaltimeout?: null | string
    Description
    Timestamp this member is timed out until
Returns null | ServerMember
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:65
resolve(
    resolvable:
        | string
        | ServerMember
        | {
            _id: { server: string; user: string };
            avatar?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            joined_at: string;
            nickname?: null
            | string;
            roles?: string[];
            timeout?: null | string;
        },
): null
| ServerMember
Parameters
- resolvable:
      | string
      | ServerMember
      | {
          _id: { server: string; user: string };
          avatar?:
              | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
          joined_at: string;
          nickname?: null
          | string;
          roles?: string[];
          timeout?: null | string;
      }
  - string
  - ServerMember
  - {
        _id: { server: string; user: string };
        avatar?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        joined_at: string;
        nickname?: null
        | string;
        roles?: string[];
        timeout?: null | string;
    }
    _id: { server: string; user: string }
    Description
    Unique member id
    
    server: string
    Description
    Server Id
    
    user: string
    Description
    User Id
    
    Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }
    Description
    Avatar attachment
    
    joined_at: string
    Description
    Time at which this user joined the server
    
    Optionalnickname?: null | string
    Description
    Member's nickname
    
    Optionalroles?: string[]
    Description
    Member's roles
    
    Optionaltimeout?: null | string
    Description
    Timestamp this member is timed out until
Returns null | ServerMember
Inherited from BaseManager.resolve
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:66

resolveId

resolveId(member: ServerMemberResolvable): null | string
resolves a member from a string or a member object
Parameters
- member: ServerMemberResolvable
  The member to resolve
Returns null | string
The id of the member or null if it cannot be resolved
Overrides BaseManager.resolveId
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:127

setMaxSize

setMaxSize(size: number): void
Adjust the maximum size for this manager at runtime.
Parameters
- size: number
Returns void
Inherited from BaseManager.setMaxSize
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:40

unban

unban(member: ServerMemberResolvable): Promise<void>
unban selected member in the server
Parameters
- member: ServerMemberResolvable
  The member to unban
Returns Promise<void>
A promise that resolves when the member is unbanned
- Defined in work/revbot.js/revbot.js/src/managers/serverMemberManager.ts:75

valueOf

valueOf(): Map<string, ServerMember>
Returns Map<string, ServerMember>
Inherited from BaseManager.valueOf
- Defined in work/revbot.js/revbot.js/src/managers/baseManager.ts:82

Class ServerMemberManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerMemberManager

Properties

Readonlycache

holds

Holds

StaticdefaultMaxSize

Methods

_add

Parameters

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

Description

joined_at: string

Description

Optionalnickname?: null | string

Description

Optionalroles?: string[]

Description

Optionaltimeout?: null | string

Description

Returns ServerMember

_remove

Parameters

Returns void

ban

Parameters

Returns Promise<void>

edit

Parameters

Optionalavatar?: string

Optionalnickname?: string

Optionalroles?: string[]

Returns Promise<void>

fetch

Parameters

Returns Promise<ServerMember>

Returns Promise<Map<string, ServerMember>>

kick

Parameters

Returns Promise<void>

resolve

Parameters

Returns null | ServerMember

Parameters

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

Description

joined_at: string

Description

Optionalnickname?: null | string

Description

Optionalroles?: string[]

Description

Optionaltimeout?: null | string

Description

Returns null | ServerMember

Parameters

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

`Readonly`cache

`Static`defaultMaxSize

`Optional`nickname?: null | string

`Optional`roles?: string[]

`Optional`timeout?: null | string

`Optional`avatar?: string

`Optional`nickname?: string

`Optional`roles?: string[]

`Optional`nickname?: null | string

`Optional`roles?: string[]

`Optional`timeout?: null | string

`Optional`nickname?: null | string

`Optional`roles?: string[]

`Optional`timeout?: null | string