Class ServerMember

Represents a server member on Guilded.

Example

new ServerMember(server, rawMember);

Hierarchy

Base
- ServerMember

Index

Constructors

constructor

new ServerMember(server: Server, raw: APIServerMember | APIServerMemberSummary, cache?: boolean): ServerMember
Parameters
- server: Server
  
  The server the member belongs to.
- raw: APIServerMember | APIServerMemberSummary
  
  The raw data of the server member.
- cache: boolean = ...
  
  Whether to cache the server member.
Returns ServerMember
Overrides Base.constructor
- Defined in guilded.ts/src/structures/server/ServerMember.ts:35

Properties

`Readonly` client

client: Client

The client the data model belongs to.

`Readonly` id

id: string

The ID of the structure.

`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

The raw data of the server member.

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

The server the member belongs to.

`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
- Defined in guilded.ts/src/structures/server/ServerMember.ts:51

joinedTimestamp

get joinedTimestamp(): undefined | number
The timestamp the member joined the server.

Returns undefined | number
- Defined in guilded.ts/src/structures/server/ServerMember.ts:56

Methods

awardXp

awardXp(amount: number): Promise<number>
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>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:127

ban

ban(reason?: string): Promise<ServerBan>
Ban the server member.

Returns
The created server ban.

Example
```
member.ban();
```
Parameters
- Optional reason: string
  
  The reason of the ban.
Returns Promise<ServerBan>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:107

fetch

fetch(options?: FetchOptions): Promise<ServerMember>
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>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:66

fetchSocialLink

fetchSocialLink(type: string): Promise<APISocialLink>
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>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:147

kick

kick(): Promise<ServerMember>
Kick the server member.

Returns
The kicked member.

Example
```
member.kick();
```
Returns Promise<ServerMember>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:96

removeNickname

removeNickname(): Promise<ServerMember>
Remove the nickname of the server member.

Returns
The edited server member.

Example
```
member.removeNickname();
```
Returns Promise<ServerMember>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:86

setNickname

setNickname(nickname: string): Promise<ServerMember>
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>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:76

setXp

setXp(amount: number): Promise<number>
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>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:137

unban

unban(): Promise<ServerMember>
Unban the server member.

Returns
The unbanned member.

Example
```
member.unban();
```
Returns Promise<ServerMember>
- Defined in guilded.ts/src/structures/server/ServerMember.ts:116

Class ServerMember

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

server: Server

raw: APIServerMember | APIServerMemberSummary

cache: boolean = ...

Returns ServerMember

Properties

Readonly client

Readonly id

Optional Readonly isOwner

Optional Readonly joinedAt

Optional nickname

Readonly raw

roleIds

Readonly roles

Readonly server

Readonly socialLinks

Readonly user

Accessors

isCached

Returns boolean

joinedTimestamp

Returns undefined | number

Methods

awardXp

Returns

Example

Parameters

amount: number

Returns Promise<number>

ban

Returns

Example

Parameters

Optional reason: string

Returns Promise<ServerBan>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchSocialLink

Returns

Example

Parameters

type: string

Returns Promise<APISocialLink>

kick

Returns

Example

Returns Promise<ServerMember>

removeNickname

Returns

Example

Returns Promise<ServerMember>

setNickname

Returns

Example

Parameters

nickname: string

Returns Promise<ServerMember>

setXp

Returns

Example

Parameters

amount: number

Returns Promise<number>

unban

Returns

Example

`Readonly` client

`Readonly` id

`Optional` `Readonly` isOwner

`Optional` `Readonly` joinedAt

`Optional` nickname

`Readonly` raw

`Readonly` roles

`Readonly` server

`Readonly` socialLinks

`Readonly` user

`Optional` reason: string

`Optional` options: FetchOptions