> ## Documentation Index
> Fetch the complete documentation index at: https://yor.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Yor.ts | classes/Member

[yor.ts](../README) / [Exports](../modules) / Member

# Class: Member

## Hierarchy

* [`Base`](Base)

  ↳ **`Member`**

## Table of contents

### Constructors

* [constructor](Member#constructor)

### Properties

* [API](Member#api)
* [client](Member#client)
* [joinedTimestamp](Member#joinedtimestamp)
* [nickname](Member#nickname)
* [raw](Member#raw)
* [user](Member#user)

### Methods

* [ban](Member#ban)
* [displayName](Member#displayname)
* [edit](Member#edit)
* [fetchGuild](Member#fetchguild)
* [joinedAt](Member#joinedat)
* [kick](Member#kick)

## Constructors

### constructor

• **new Member**(`client`, `guildID`, `member`): [`Member`](Member)

Constructs a new instance of the constructor.

#### Parameters

| Name      | Type                        | Description          |
| :-------- | :-------------------------- | :------------------- |
| `client`  | [`YorClient`](YorClient)    | The client object.   |
| `guildID` | `string`                    | The ID of the guild. |
| `member`  | `APIInteractionGuildMember` | The member object.   |

#### Returns

[`Member`](Member)

#### Overrides

[Base](Base).[constructor](Base#constructor)

#### Defined in

[src/structures/Member.ts:29](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L29)

## Properties

### API

• `Private` **API**: `GuildsAPI`

#### Defined in

[src/structures/Member.ts:15](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L15)

***

### client

• **client**: [`YorClient`](YorClient)

#### Inherited from

[Base](Base).[client](Base#client)

#### Defined in

[src/structures/Base.ts:4](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Base.ts#L4)

***

### joinedTimestamp

• `Optional` **joinedTimestamp**: `number`

#### Defined in

[src/structures/Member.ts:20](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L20)

***

### nickname

• `Optional` **nickname**: `string`

#### Defined in

[src/structures/Member.ts:19](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L19)

***

### raw

• **raw**: `APIInteractionGuildMember` & \{ `guildID`: `string`  }

#### Defined in

[src/structures/Member.ts:17](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L17)

***

### user

• **user**: [`User`](User)

#### Defined in

[src/structures/Member.ts:18](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L18)

## Methods

### ban

▸ **ban**(`data?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

Bans a user with optional additional data.

#### Parameters

| Name    | Type                                                    | Description                                                                                                              |
| :------ | :------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------- |
| `data?` | `RESTPutAPIGuildBanJSONBody` & \{ `reason`: `string`  } | The optional additional data for banning the user. It can include properties like `delete_message_seconds` and `reason`. |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`>

A promise that resolves when the user is successfully banned.

#### Defined in

[src/structures/Member.ts:51](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L51)

***

### displayName

▸ **displayName**(): `string`

Returns the display name for the member.

#### Returns

`string`

The display name of the member.

#### Defined in

[src/structures/Member.ts:99](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L99)

***

### edit

▸ **edit**(`data`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIGuildMember`>

Edits a guild member.

#### Parameters

| Name   | Type                                                          | Description                                                                                   |
| :----- | :------------------------------------------------------------ | :-------------------------------------------------------------------------------------------- |
| `data` | `RESTPatchAPIGuildMemberJSONBody` & \{ `reason?`: `string`  } | The data to edit the guild member with. It should include the reason as a string if provided. |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIGuildMember`>

A promise that resolves with the edited guild member object.

#### Defined in

[src/structures/Member.ts:109](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L109)

***

### fetchGuild

▸ **fetchGuild**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Guild`](Guild)>

Fetches a guild using the guild ID.

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Guild`](Guild)>

A Promise that resolves with the fetched Guild object.

#### Defined in

[src/structures/Member.ts:81](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L81)

***

### joinedAt

▸ **joinedAt**(): `undefined` | [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date)

Returns the joined date of the user as a Date object.

#### Returns

`undefined` | [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date)

* The joined date of the user, or undefined if the joined timestamp is not set.

#### Defined in

[src/structures/Member.ts:90](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L90)

***

### kick

▸ **kick**(`reason?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`>

Kick a member from the guild.

#### Parameters

| Name      | Type     | Description                        |
| :-------- | :------- | :--------------------------------- |
| `reason?` | `string` | The reason for the kick, optional. |

#### Returns

[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`>

A promise that resolves with the result of the kick.

#### Defined in

[src/structures/Member.ts:68](https://github.com/OreOreki/yor.ts/blob/ff21935/src/structures/Member.ts#L68)