Skip to content

Commit

Permalink
docs: add user consent section
Browse files Browse the repository at this point in the history
  • Loading branch information
jhaaaa committed Nov 1, 2023
1 parent 28fed28 commit 91c2e02
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,18 @@ for await (const message of await xmtp.conversations.streamAllMessages()) {
}
```

## Request and respect user consent

![Feature status](https://img.shields.io/badge/Feature_status-Alpha-orange)

The user consent feature enables your app to request and respect user consent preferences. With this feature, a blockchain account address registered on the XMTP network can have one of three consent preference values:

- Unknown
- Allowed
- Denied

To learn more, see [Request and respect user consent](https://xmtp.org/docs/build/user-consent).

## Check if an address is on the network

If you would like to check and see if a blockchain address is registered on the network before instantiating a client instance, you can use `Client.canMessage`.
Expand Down

0 comments on commit 91c2e02

Please sign in to comment.