> For the complete documentation index, see [llms.txt](https://legacy.docs.touchguild.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy.docs.touchguild.com/documentation/select-version/v.0.1.7/components/calendarevent.md).

# CalendarEvent

## Properties

| Property                | Description                                         | Type                                                                                                                    |
| ----------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| data                    | raw data                                            | Object                                                                                                                  |
| client                  | client                                              | [Client](/documentation/select-version/v.0.1.7/components/client.md)                                                    |
| id                      | event id                                            | String                                                                                                                  |
| guildID                 | guild id                                            | String                                                                                                                  |
| channelID               | id of the channel                                   | String                                                                                                                  |
| name                    | event name                                          | String                                                                                                                  |
| description             | event description                                   | String                                                                                                                  |
| location                | event location set by member                        | String                                                                                                                  |
| url                     | event url set by member                             | String                                                                                                                  |
| color                   | event color                                         | Number                                                                                                                  |
| rsvpLimit               | attendant/entry limit                               | Number                                                                                                                  |
| \_startsAt              | timestamp of when the event starts.                 | Number\|null                                                                                                            |
| duration                | duration in ms of the event                         | Number                                                                                                                  |
| isPrivate               | //                                                  | Boolean                                                                                                                 |
| mentions                | event's mentions                                    | Object ([<mark style="color:purple;">MentionsType</mark>](/documentation/select-version/v.0.1.6/types/mentionstype.md)) |
| \_createdAt             | timestamp of the event's creation.                  | Number\|null                                                                                                            |
| memberID                | id of the member who created the event.             | String                                                                                                                  |
| cancelation             | cancelation info (if canceled)                      | Object\|null                                                                                                            |
| cancelation.description | cancelation description                             | String                                                                                                                  |
| cancelation.createdBy   | id of the member who canceled the event.            | String                                                                                                                  |
| member                  | Member that created the event.                      | [Member](/documentation/select-version/v.0.1.7/components/member.md)                                                    |
| createdAt               | string representation of the \_createdAt timestamp. | Date                                                                                                                    |

## Constructor

```javascript
new CalendarEvent(rawData, client)
```

| Properties | Description                                     | Type                                                                 | Required? |
| ---------- | ----------------------------------------------- | -------------------------------------------------------------------- | --------- |
| rawData    | raw data received from ws and converted to JSON | Object                                                               | true      |
| client     | Client                                          | [Client](/documentation/select-version/v.0.1.7/components/client.md) | true      |

{% hint style="danger" %}
Do not use this constructor unless you know what you're doing. This constructor is used to return you rawdata into component.
{% endhint %}

## Methods

### edit(options)

Edit the calendar event.

| Properties           | Description               | Type    | Required? |
| -------------------- | ------------------------- | ------- | --------- |
| options              | edit options              | Object  | true      |
| options.name?        | new event's name          | String  | false     |
| options.description? | new event's description   | String  | false     |
| options.location?    | new event's location      | String  | false     |
| options.startsAt?    | date-time string          | String  | false     |
| options.url?         | new event's url           | String  | false     |
| options.color?       | new event's color         | Number  | false     |
| options.rsvpLimit?   | new event's entry limit   | Number  | false     |
| options.duration?    | new event's duration      | Number  | false     |
| options.isPrivate?   | new event's private param | Boolean | false     |

> Returns: <mark style="color:purple;">Promise<</mark>[<mark style="color:purple;">CalendarEvent</mark>](/documentation/select-version/v.0.1.7/components/calendarevent.md)<mark style="color:purple;">></mark>

### delete()

Delete the calendar event.

> Returns: <mark style="color:purple;">Promise\<void></mark>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://legacy.docs.touchguild.com/documentation/select-version/v.0.1.7/components/calendarevent.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.