Class ServerMember

Represents a server member on Guilded.

Example

new ServerMember(server, rawMember);

Hierarchy

Constructors

constructor

Properties

client id isOwner? joinedAt? nickname? raw roleIds roles server socialLinks user

Accessors

isCached joinedTimestamp

Methods

awardXp ban fetch fetchSocialLink kick removeNickname setNickname setXp unban

Constructors

constructor

Properties

Readonly client

client: Client

Readonly id

id: string

Optional Readonly isOwner

isOwner?: boolean

Whether the server member is the server owner.

Optional Readonly joinedAt

joinedAt?: Date

The date the member joined the server.

Optional nickname

nickname?: string

The nickname of the server member.

Readonly raw

raw: APIServerMember | APIServerMemberSummary

roleIds

roleIds: number[]

The IDs of roles the server member has.

Readonly roles

roles: ServerMemberRoleManager

The manager of roles that belong to the server member.

Readonly server

server: Server

Readonly socialLinks

socialLinks: Collection<string, APISocialLink>

The social links of the server member.

Readonly user

user: User

The user the server member belongs to.

Accessors

isCached

  • get isCached(): boolean

  • Whether the server member is cached.

    Returns boolean

joinedTimestamp

  • get joinedTimestamp(): undefined | number

  • The timestamp the member joined the server.

    Returns undefined | number

Methods

awardXp

  • Award XP to the server member.

    Returns

    The total amount of XP the server member has.

    Example

    member.awardXp(100);

    Parameters

    • amount: number

      The amount of XP to award.

    Returns Promise<number>

ban

  • Ban the server member.

    Returns

    The created server ban.

    Example

    member.ban();

    Parameters

    • Optional reason: string

      The reason of the ban.

    Returns Promise<ServerBan>

fetch

  • Fetch the server member.

    Returns

    The fetched server member.

    Example

    member.fetch();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server member with.

    Returns Promise<ServerMember>

fetchSocialLink

  • Fetch a social link of the server member.

    Returns

    The fetched social link.

    Example

    member.fetchSocialLink('youtube');

    Parameters

    • type: string

      The type of social link to fetch.

    Returns Promise<APISocialLink>

kick

  • Kick the server member.

    Returns

    The kicked member.

    Example

    member.kick();

    Returns Promise<ServerMember>

removeNickname

  • Remove the nickname of the server member.

    Returns

    The edited server member.

    Example

    member.removeNickname();

    Returns Promise<ServerMember>

setNickname

  • Set the nickname of the server member.

    Returns

    The edited server member.

    Example

    member.setNickname('new nickname');

    Parameters

    • nickname: string

      The nickname of the server member.

    Returns Promise<ServerMember>

setXp

  • Set XP of the server member.

    Returns

    The total amount of XP the server member has.

    Example

    member.setXp(100);

    Parameters

    • amount: number

      The total XP of the server member.

    Returns Promise<number>

unban

  • Unban the server member.

    Returns

    The unbanned member.

    Example

    member.unban();

    Returns Promise<ServerMember>

Settings

Member Visibility

Theme