Interface PartialGuildMember

interface PartialGuildMember {
    avatar: null | string;
    avatarDecorationData: null | AvatarDecorationData;
    bannable: boolean;
    banner: null | string;
    client: Client<true>;
    communicationDisabledUntil: null | Date;
    communicationDisabledUntilTimestamp: null | number;
    displayColor: number;
    displayHexColor: `#${string}`;
    displayName: string;
    dmChannel: null | DMChannel;
    flags: Readonly<GuildMemberFlagsBitField>;
    guild: Guild;
    id: string;
    joinedAt: null;
    joinedTimestamp: null;
    kickable: boolean;
    manageable: boolean;
    moderatable: boolean;
    nickname: null | string;
    partial: true;
    pending: null;
    permissions: Readonly<PermissionsBitField>;
    premiumSince: null | Date;
    premiumSinceTimestamp: null | number;
    presence: null | Presence;
    roles: GuildMemberRoleManager;
    user: User;
    voice: VoiceState;
    avatarDecorationURL(): null | string;
    avatarURL(options?: ImageURLOptions): null | string;
    ban(options?: BanOptions): Promise<GuildMember>;
    bannerURL(options?: ImageURLOptions): null | string;
    createDM(force?: boolean): Promise<DMChannel>;
    deleteDM(): Promise<DMChannel>;
    disableCommunicationUntil(
        timeout: null | DateResolvable,
        reason?: string,
    ): Promise<GuildMember>;
    displayAvatarDecorationURL(): null | string;
    displayAvatarURL(options?: ImageURLOptions): string;
    displayBannerURL(options?: ImageURLOptions): null | string;
    edit(options: GuildMemberEditOptions): Promise<GuildMember>;
    fetch(force?: boolean): Promise<GuildMember>;
    isCommunicationDisabled(): this is GuildMember & {
        communicationDisabledUntil: Date;
        communicationDisabledUntilTimestamp: number;
    };
    kick(reason?: string): Promise<GuildMember>;
    permissionsIn(
        channel: GuildChannelResolvable,
    ): Readonly<PermissionsBitField>;
    send(
        options: string | MessagePayload | MessageCreateOptions,
    ): Promise<Message<false>>;
    setFlags(
        flags: GuildMemberFlagsResolvable,
        reason?: string,
    ): Promise<GuildMember>;
    setNickname(nickname: null | string, reason?: string): Promise<GuildMember>;
    timeout(timeout: null | number, reason?: string): Promise<GuildMember>;
    toJSON(): unknown;
    toString(): `<@${string}>`;
    valueOf(): string;
}

Hierarchy (View Summary)

Properties

avatar avatarDecorationData bannable banner client communicationDisabledUntil communicationDisabledUntilTimestamp displayColor displayHexColor displayName dmChannel flags guild id joinedAt joinedTimestamp kickable manageable moderatable nickname partial pending permissions premiumSince premiumSinceTimestamp presence roles user voice

Methods

avatarDecorationURL avatarURL ban bannerURL createDM deleteDM disableCommunicationUntil displayAvatarDecorationURL displayAvatarURL displayBannerURL edit fetch isCommunicationDisabled kick permissionsIn send setFlags setNickname timeout toJSON toString valueOf

Properties

avatar

avatar: null | string

avatarDecorationData

avatarDecorationData: null | AvatarDecorationData

bannable

bannable: boolean

banner

banner: null | string

Readonlyclient

client: Client<true>

communicationDisabledUntil

communicationDisabledUntil: null | Date

communicationDisabledUntilTimestamp

communicationDisabledUntilTimestamp: null | number

displayColor

displayColor: number

displayHexColor

displayHexColor: `#${string}`

displayName

displayName: string

dmChannel

dmChannel: null | DMChannel

flags

flags: Readonly<GuildMemberFlagsBitField>

guild

guild: Guild

id

id: string

joinedAt

joinedAt: null

joinedTimestamp

joinedTimestamp: null

kickable

kickable: boolean

manageable

manageable: boolean

moderatable

moderatable: boolean

nickname

nickname: null | string

partial

partial: true

pending

pending: null

permissions

permissions: Readonly<PermissionsBitField>

premiumSince

premiumSince: null | Date

premiumSinceTimestamp

premiumSinceTimestamp: null | number

presence

presence: null | Presence

roles

roles: GuildMemberRoleManager

user

user: User

voice

voice: VoiceState

Methods

avatarDecorationURL

  • avatarDecorationURL(): null | string

    Returns null | string

avatarURL

  • avatarURL(options?: ImageURLOptions): null | string

    Parameters

    Returns null | string

ban

bannerURL

  • bannerURL(options?: ImageURLOptions): null | string

    Parameters

    Returns null | string

createDM

  • createDM(force?: boolean): Promise<DMChannel>

    Parameters

    • Optionalforce: boolean

    Returns Promise<DMChannel>

deleteDM

disableCommunicationUntil

displayAvatarDecorationURL

  • displayAvatarDecorationURL(): null | string

    Returns null | string

displayAvatarURL

  • displayAvatarURL(options?: ImageURLOptions): string

    Parameters

    Returns string

displayBannerURL

  • displayBannerURL(options?: ImageURLOptions): null | string

    Parameters

    Returns null | string

edit

fetch

  • fetch(force?: boolean): Promise<GuildMember>

    Parameters

    • Optionalforce: boolean

    Returns Promise<GuildMember>

isCommunicationDisabled

  • isCommunicationDisabled(): this is GuildMember & {
        communicationDisabledUntil: Date;
        communicationDisabledUntilTimestamp: number;
    }

    Returns this is GuildMember & {
        communicationDisabledUntil: Date;
        communicationDisabledUntilTimestamp: number;
    }

kick

  • kick(reason?: string): Promise<GuildMember>

    Parameters

    • Optionalreason: string

    Returns Promise<GuildMember>

permissionsIn

send

setFlags

setNickname

  • setNickname(nickname: null | string, reason?: string): Promise<GuildMember>

    Parameters

    • nickname: null | string
    • Optionalreason: string

    Returns Promise<GuildMember>

timeout

  • timeout(timeout: null | number, reason?: string): Promise<GuildMember>

    Parameters

    • timeout: null | number
    • Optionalreason: string

    Returns Promise<GuildMember>

toJSON

  • toJSON(): unknown

    Returns unknown

toString

  • toString(): `<@${string}>`

    Returns a string representation of an object.

    Returns `<@${string}>`

valueOf

  • valueOf(): string

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods