Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Message forwarding #6833

Merged
merged 12 commits into from
Jul 16, 2024
Merged

Message forwarding #6833

merged 12 commits into from
Jul 16, 2024

Conversation

shaydewael
Copy link
Contributor

@shaydewael shaydewael commented May 1, 2024

@shaydewael shaydewael added the not released This issue or PR is referencing a change that is not yet widely released and/or subject to change. label May 1, 2024
@sebm253 sebm253 mentioned this pull request May 1, 2024
3 tasks
@lytefast lytefast self-assigned this Jun 5, 2024
docs/resources/Channel.md Outdated Show resolved Hide resolved
@lytefast
Copy link
Contributor

@shaydewael this is ready to be merged.

@lytefast lytefast added documentation messaging and removed not released This issue or PR is referencing a change that is not yet widely released and/or subject to change. labels Jul 12, 2024
docs/Change_Log.md Outdated Show resolved Hide resolved
docs/Change_Log.md Outdated Show resolved Hide resolved
docs/Change_Log.md Outdated Show resolved Hide resolved
| message\* | [message] | subset of fields in the [message object](#DOCS_RESOURCES_CHANNEL/message-object) |

\* The current list of message fields subset consists of:
'type`, `content`, `embeds`, `attachments`, `timestamp`, `edited_timestamp`, `flags`, `mentions`, `mention_roles`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'type`, `content`, `embeds`, `attachments`, `timestamp`, `edited_timestamp`, `flags`, `mentions`, `mention_roles`.
`type`, `content`, `embeds`, `attachments`, `timestamp`, `edited_timestamp`, `flags`, `mentions`, `mention_roles`.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it intended that mention_roles is only returned on the Get Message(s) endpoints?

docs/Change_Log.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/Change_Log.md Outdated Show resolved Hide resolved
docs/Change_Log.md Outdated Show resolved Hide resolved
lytefast added 8 commits July 15, 2024 19:31
Add documentation for message forwards.

A message forward gives users the ability to send a snapshot of a message in one channel to another channel.
- snapshots are immutable, and do not receive updates from the original message (unlike replies)
- similar to a REPLY message, a forward is created using a `message_reference`

 # Examples
 ## Responses
```json
{
    "author": {
        "id": 123456789012345678,
    },
    "message_reference": {
        "type": 1,  // FORWARD
        "message_id": 123456789012345678,
        "channel_id": 123456789012345678,
        "guild_id": 123456789012345678
    },
    "message_snapshot": {
        "content": "hello world",
        "embeds": [
            // Embed objects
        ],
        "attachments": [
            // Attachment objects
        ],
    }
}

```
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved
docs/resources/Channel.md Outdated Show resolved Hide resolved

#### July 15, 2024

We are slowly rolling out the message forwarding feature to users. This feature allows callers to create a message using `message_reference.type = FORWARD` and have the API generate a `message_snapshot` for the sent message. The feature has [some limitations](#DOCS_RESOURCES_CHANNEL/message-reference-types) and the snapshot is a minimal version of a standard `MessageObject`, but does capture the core parts of a message.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We are slowly rolling out the message forwarding feature to users. This feature allows callers to create a message using `message_reference.type = FORWARD` and have the API generate a `message_snapshot` for the sent message. The feature has [some limitations](#DOCS_RESOURCES_CHANNEL/message-reference-types) and the snapshot is a minimal version of a standard `MessageObject`, but does capture the core parts of a message.
We are slowly rolling out the message forwarding feature to users. This feature allows to create a message using `message_reference.type = FORWARD` and have the API generate a `message_snapshot` for the sent message. The feature has [some limitations](#DOCS_RESOURCES_CHANNEL/message-reference-types) and the snapshot is a minimal version of a standard message object that only captures the core parts.

shaydewael and others added 4 commits July 16, 2024 10:57
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
@colinloretz colinloretz self-requested a review July 16, 2024 16:33
@lytefast lytefast merged commit 86641ea into main Jul 16, 2024
4 checks passed
@lytefast lytefast deleted the msgs/forwards branch July 16, 2024 17:15
DonovanDMC added a commit to OceanicJS/Oceanic that referenced this pull request Jul 16, 2024
suneettipirneni added a commit to twilight-rs/twilight that referenced this pull request Jul 18, 2024
@DA-344 DA-344 mentioned this pull request Sep 29, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants