Skip to content

fix chat docs #10

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.

Sign up for GitHub

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

Merged
corlard3y merged 1 commit into from
Feb 12, 2025
Merged

fix chat docs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/chat/02-message-types/05-Message-Type-Reaction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import TabItem from '@theme/TabItem';
const aliceMessagesBob = await userAlice.chat.send(recipient, {
type: 'Reaction',
content: '👍', // content can be eliminated
action: 'ThumbsUp', // can be "ThumbsUp", "ThumbsDown", "Heart", "Clap", "Laugh", "Sad", etc
reference: 'bafyreia2okco5ocdxmoxon72erviypaht74u3dqunf3vydu237ybju4kw4', // pass in the reference to the message hash that this reaction is intended for
});
```
Expand All @@ -48,7 +47,6 @@ When sending a message, you can customize the following params
| _`message`_ | `object` | - | - | Configuration for message to be sent |
| - | _`message.type`_ | `Meta` | `Text` | Type of message Content |
| - | _`message.content`_ | `string` | - | Emoji Symbol - 👍, 👎, ❤️, 👏, 😄, 😢 |
| - | _`options.action`_ | `string`, choose from `ThumbsUp`, `ThumbsDown`, `Heart`, `Clap`, `Laugh`, `Sad` | - | Action that is getting applied in the Meta message action |
| - | _`options.reference`_ | `{ affected : string[]: arbitrary?: { [key: string]: any } }` | - | Pass in the reference to the message hash that this reaction is intended for |
| - | _`options.reference`_ | `string` | - | Pass in the reference to the message hash that this reaction is intended for |

> Note: Parameters _`in this style`_ are mandatory.
4 changes: 1 addition & 3 deletions docs/chat/02-message-types/06-Message-Type-Meta.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import TabItem from '@theme/TabItem';
const aliceMessagesBob = await userAlice.chat.send(recipient, {
type: 'Meta',
content: "Alice.eth create the grp 'xyz'", // content can be eliminated
action: "CreateGroup", // can be "AddMember", "RemoveMember", "PromoteAdmin", etc
info: { // any added info that is not visible but can be programmatically understood
affected: [], // recipients // this can be array
arbitary: { // optional, can have anything, never shown based on type
Expand All @@ -52,8 +51,7 @@ When sending a message, you can customize the following params
| _`recipient`_ | `string` | - | - | [Recipient supports a number of address format](/docs/chat/supported-wallet-standards/ 'Supported wallet standards for Push Chat') including wallet address, chain agnostic wallet address, NFT addresses or even chatid which is useful in groups |
| _`message`_ | `object` | - | - | Configuration for message to be sent |
| - | _`message.type`_ | `Meta` | `Text` | Type of message Content |
| - | _`message.content`_ | `string` | - | Message Content |
| - | _`options.action`_ | `string`, choose from `CreateGroup`, `AddMember`, `RemoveMember`, `PromoteAdmin`, `DemoteAdmin`, `UpdareGroupinfo` | - | Action that is getting applied in the Meta message action |
| - | _`message.content`_ | `CREATE_GROUP` or `ADD_MEMBER` or `REMOVE_MEMBER` or `ASSIGN_MEMBER_PRIVILEGE` or `UPDATE_GROUP` or `UPDATE_GROUP_PROFILE` or `UPDATE_GROUP_META` or `USER_INTERACTION` or `CREATE_SPACE` or `ADD_LISTENER` or `REMOVE_LISTENER` or `ASSIGN_LISTENER_PRIVILEGE` or `ASSIGN_SPEAKER_PRIVILEGE` or `ASSIGN_COHOST_PRIVILEGE` | - | Message Content |
| - | _`options.info`_ | `{ affected : string[]: arbitrary?: { [key: string]: any } }` | - | Pass recipients in the affected array list, any arbitary data if applicable can be passed in arbitary object |

> Note: Parameters _`in this style`_ are mandatory.
Loading