Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
GITBOOK-1270: [Update] Realtime API deprecations
Browse files Browse the repository at this point in the history
  • Loading branch information
Faria1212 authored and gitbook-bot committed Mar 23, 2024
1 parent ec01264 commit b567fc4
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 15 deletions.
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# Check Username Availability

<figure><img src="../../../../.gitbook/assets/Deprecated.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
This method is planned to be removed by 7.0.0. Use the `/users.checkUsernameAvailability` endpoint instead.
{% endhint %}

Confirm if a username is available.

| Name | Requires Auth | Permission | Setting |
| --------------------------- | ------------- | ---------- | ------- |
| `checkUsernameAvailability` | Yes | | `None` |
| Name | Requires Auth |
| --------------------------- | ------------- |
| `checkUsernameAvailability` | Yes |

### Payload Parameters <a href="#payload-parameters" id="payload-parameters"></a>

| Argument | Example | Required | Description |
| ---------- | ----------- | -------- | ---------------------------------- |
| `username` | `john.wood` | Required | The username you are checking for. |
<table data-header-hidden><thead><tr><th width="161"></th><th width="161"></th><th width="166"></th><th></th></tr></thead><tbody><tr><td>Argument</td><td>Example</td><td>Required</td><td>Description</td></tr><tr><td><code>username</code></td><td><code>john.wood</code></td><td>Required</td><td>The username you are checking for.</td></tr></tbody></table>

## Example call

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Delete Message

<figure><img src="../../../../../.gitbook/assets/Deprecated.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
This method is planned to be removed by 7.0.0. Use the [`/chat.delete`](https://developer.rocket.chat/reference/api/rest-api/endpoints/messaging/chat-endpoints/delete) endpoint instead.
{% endhint %}

Delete a message by the message id.

| Name | Requires Auth | Permission | Setting |
| --------------- | ------------- | ---------------- | -------------------------------------------------- |
| `deleteMessage` | Yes | `delete-message` | `Message_AllowDeleting` - "Allow Message Deleting" |
<table><thead><tr><th>Name</th><th width="150">Requires Auth</th><th>Permission</th><th>Setting</th></tr></thead><tbody><tr><td><code>deleteMessage</code></td><td>Yes</td><td><code>delete-message</code></td><td><code>Message_AllowDeleting</code> - "Allow Message Deleting"</td></tr></tbody></table>

## Settings

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Check If Room Name Exists

<figure><img src="../../../../../.gitbook/assets/Deprecated.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
This method is planned to be removed by 7.0.0. Use the `/rooms.roomNameExists` endpoint instead.
{% endhint %}

Check if a room name exists in a workspace.

| Name | Requires Auth | Permission | Setting |
| ---------------- | ------------- | ---------- | ------- |
| `roomNameExists` | Yes | | |
| Name | Requires Auth |
| ---------------- | ------------- |
| `roomNameExists` | Yes |

### Payload Parameters <a href="#payload-parameters" id="payload-parameters"></a>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# List Custom Emoji

<figure><img src="../../../../../.gitbook/assets/Deprecated.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
This method is planned to be removed by 7.0.0. Use the [`/emoji-custom.list`](https://developer.rocket.chat/reference/api/rest-api/endpoints/content-management/custom-emoji-endpoints/list-custom-emojis) endpoint instead.
{% endhint %}

Returns a list of [custom emoji ](https://docs.rocket.chat/use-rocket.chat/workspace-administration/custom-emoji)registered in the workspace.

| Name | Requires Auth | Permission | Setting |
| ----------------- | ------------- | ---------- | ------- |
| `listEmojiCustom` | Yes | | |
| Name | Requires Auth |
| ----------------- | ------------- |
| `listEmojiCustom` | Yes |

### Example Call

Expand Down

0 comments on commit b567fc4

Please sign in to comment.