Class Member

Hierarchy

BaseObject<API.Member>
- Member

Index

Constructors

Properties

Accessors

_id avatar bannable colorRole createdAt hoistedRole id inferior joinedAt kickable nickname permissions ranking roles server serverID source timeoutEnds user

Methods

addRole ban edit fetchUser fireUpdate generateAvatarURL inferiorTo kick offUpdate onUpdate removeRole scheduleTimeoutClear timeout toString update

Constructors

constructor

new Member(client: Client, data: {
    _id: {
        server: string;
        user: string;
    };
    avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    joined_at: string;
    nickname?: string;
    roles?: string[];
    timeout?: string;
}): Member
Parameters
- client: Client
- data: {
      _id: {
          server: string;
          user: string;
      };
      avatar?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      joined_at: string;
      nickname?: string;
      roles?: string[];
      timeout?: string;
  }
  - _id: {
    server: string;
    user: string;
    }
    
    Description
    Unique member id
    - server: string
      
      Description
      Server Id
    - user: string
      
      Description
      User Id
  - Optional avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Avatar attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - joined_at: string
    
    Description
    Time at which this user joined the server
  - Optional nickname?: string
    
    Description
    Member's nickname
  - Optional roles?: string[]
    
    Description
    Member's roles
  - Optional timeout?: string
    
    Description
    Timestamp this member is timed out until
Returns Member
Overrides BaseObject.constructor
- Defined in core/src/objects/Member.ts:11

Properties

client

client: Client

deleted

deleted: boolean = false

`Private` timeoutClearer

timeoutClearer: Timeout

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

avatar

get avatar(): Attachment
Returns Attachment
- Defined in core/src/objects/Member.ts:58

bannable

get bannable(): boolean
If you can ban this member.

Returns boolean
- Defined in core/src/objects/Member.ts:85

colorRole

get colorRole(): Role
This member's role defining its color. (if any)

Returns Role
- Defined in core/src/objects/Member.ts:37

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

hoistedRole

get hoistedRole(): Role
This member's hoisted role. (if any)

Returns Role
- Defined in core/src/objects/Member.ts:33

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

inferior

get inferior(): boolean
Whether you have a higher rank than this member.

Returns boolean
- Defined in core/src/objects/Member.ts:77

joinedAt

get joinedAt(): Date
Returns Date
- Defined in core/src/objects/Member.ts:17

kickable

get kickable(): boolean
If you can kick this member.

Returns boolean
- Defined in core/src/objects/Member.ts:81

nickname

get nickname(): string
Returns string
- Defined in core/src/objects/Member.ts:20

permissions

get permissions(): PermissionFlags
This member's permissions.

Returns PermissionFlags
- Defined in core/src/objects/Member.ts:66

ranking

get ranking(): number
Get member rank. Smaller = Higher Rank

Returns number
- Defined in core/src/objects/Member.ts:70

roles

get roles(): Role[]
This member's roles. Automatically sorted.

Returns Role[]
- Defined in core/src/objects/Member.ts:24

server

get server(): Server
Returns Server
- Defined in core/src/objects/Member.ts:48

serverID

get serverID(): string
Returns string
- Defined in core/src/objects/Member.ts:45

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

timeoutEnds

get timeoutEnds(): Date
The Date this member's timeout ends.

Returns Date
- Defined in core/src/objects/Member.ts:41

user

get user(): User
Returns User
- Defined in core/src/objects/Member.ts:51

Methods

addRole

addRole(role: Role): Promise<void>
Add a role to this member.
Parameters
- role: Role
Returns Promise<void>
- Defined in core/src/objects/Member.ts:100

ban

ban(data?: {
reason?: string;
}): Promise<void>
Ban this member.
Parameters
- Optional data: {
  reason?: string;
  }
  - Optional reason?: string
    
    Description
    Ban reason
Returns Promise<void>
- Defined in core/src/objects/Member.ts:125

edit

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

fetchUser

fetchUser(): Promise<User>
Returns Promise<User>
- Defined in core/src/objects/Member.ts:54

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from BaseObject.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

generateAvatarURL

generateAvatarURL(...args: AttachmentArgs): string
Parameters
- Rest ...args: AttachmentArgs
Returns string
- Defined in core/src/objects/Member.ts:61

inferiorTo

inferiorTo(target: Member): boolean
If the target's rank is higher than this member.
Parameters
- target: Member
Returns boolean
- Defined in core/src/objects/Member.ts:89

kick

kick(): Promise<void>
Kick this member.

Returns Promise<void>
- Defined in core/src/objects/Member.ts:121

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): Member
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns Member
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): Member
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns Member
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

removeRole

removeRole(role: Role): Promise<void>
Remove a role from this member.
Parameters
- role: Role
Returns Promise<void>
- Defined in core/src/objects/Member.ts:106

`Private` scheduleTimeoutClear

scheduleTimeoutClear(): void
Returns void
- Defined in core/src/objects/Member.ts:130

timeout

timeout(ends: number): Promise<void>
Set or remove the timeout for this member.
Parameters
- ends: number
  
  Epoch time for timeout to end or null to remove.
Returns Promise<void>
- Defined in core/src/objects/Member.ts:115

toString

toString(): string
Returns
The member's user formatted for markdown. <@id>

Returns string
Overrides BaseObject.toString
- Defined in core/src/objects/Member.ts:145

update

update(data?: Partial<{
    _id: {
        server: string;
        user: string;
    };
    avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    joined_at: string;
    nickname?: string;
    roles?: string[];
    timeout?: string;
}>): Member
Update this object with new API data.
Parameters
- data: Partial<{
      _id: {
          server: string;
          user: string;
      };
      avatar?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      joined_at: string;
      nickname?: string;
      roles?: string[];
      timeout?: string;
  }> = {}
Returns Member
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24

Class Member

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

_id: { server: string; user: string; }

Description

server: string

Description

user: string

Description

Description

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

metadata: { type: "File"; } | { type: "Text"; } | { height: number; type: "Image"; width: number; } | { height: number; type: "Video"; width: number; } | { type: "Audio"; }

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

Description

tag: string

Description

Optional user_id?: string

joined_at: string

Description

Optional nickname?: string

Description

Optional roles?: string[]

Description

Optional timeout?: string

Description

Returns Member

Properties

client

deleted

Private timeoutClearer

Accessors

Protected _id

Returns ""

avatar

Returns Attachment

bannable

Returns boolean

colorRole

Returns Role

createdAt

Returns number

hoistedRole

Returns Role

id

Returns string

inferior

Returns boolean

joinedAt

Returns Date

kickable

Returns boolean

nickname

Returns string

permissions

Returns PermissionFlags

ranking

Returns number

roles

_id: {
server: string;
user: string;
}

`Optional` deleted?: boolean

`Optional` message_id?: string

metadata: {
type: "File";
} | {
type: "Text";
} | {
height: number;
type: "Image";
width: number;
} | {
height: number;
type: "Video";
width: number;
} | {
type: "Audio";
}

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` nickname?: string

`Optional` roles?: string[]

`Optional` timeout?: string

`Private` timeoutClearer

`Protected` _id

`Optional` data: {
reason?: string;
}

`Optional` reason?: string

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

`Optional` avatar?: string

`Optional` nickname?: string

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

`Optional` roles?: string[]

`Optional` timeout?: string

`Optional` updated: any[]

`Rest` ...args: AttachmentArgs