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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:16

Properties

`Readonly`cache

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

Insertion ordered cache of items this manager holds.

`Static`defaultMaxSize

defaultMaxSize: number = -1

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

Methods

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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:48

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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:29

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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:89
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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:90

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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:63

resolve

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

resolveId

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

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/stoatbot.js/stoatbot.js/src/managers/baseManager.ts:44

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/stoatbot.js/stoatbot.js/src/managers/serverMemberManager.ts:76

valueOf

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

Class ServerMemberManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerMemberManager

Properties

Readonlycache

StaticdefaultMaxSize

Methods

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 ServerMember | null

Parameters

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

Description

joined_at: string

Description

Optionalnickname?: string | null

Description

Optionalroles?: string[]

Description

Optionaltimeout?: string | null

Description

Returns ServerMember | null

Parameters

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

Description

joined_at: string

Description

Optionalnickname?: string | null

Description

Optionalroles?: string[]

Description

Optionaltimeout?: string | null

Description

Returns ServerMember | null

resolveId

Parameters

Returns string | null

setMaxSize

Parameters

Returns void

unban

Parameters

Returns Promise<void>

valueOf

Returns Map<string, ServerMember>

Settings

On This Page

`Readonly`cache

`Static`defaultMaxSize

`Optional`avatar?: string

`Optional`nickname?: string

`Optional`roles?: string[]

`Optional`nickname?: string | null

`Optional`roles?: string[]

`Optional`timeout?: string | null

`Optional`nickname?: string | null

`Optional`roles?: string[]

`Optional`timeout?: string | null