From 91c2e029af139e7baaccff0d98bce8b12406f03b Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa <5481259+jhaaaa@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:12:35 -0700 Subject: [PATCH 1/2] docs: add user consent section --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 5696ec4ba..8ca4b2959 100644 --- a/README.md +++ b/README.md @@ -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`. From 89c33d560ac3f075e7bbc588c50ee0ae3c7b403a Mon Sep 17 00:00:00 2001 From: J-Ha <5481259+jhaaaa@users.noreply.github.com> Date: Wed, 1 Nov 2023 14:22:58 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Saul Carlin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ca4b2959..a44997acd 100644 --- a/README.md +++ b/README.md @@ -259,7 +259,7 @@ for await (const message of await xmtp.conversations.streamAllMessages()) { ![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: +The user consent feature enables your app to request and respect user consent preferences. With this feature, another blockchain account address registered on the XMTP network can have one of three consent preference values: - Unknown - Allowed