From 0acdf657fd6615414e7ee11c41f9c38305fd4e8d Mon Sep 17 00:00:00 2001 From: J-Ha <5481259+jhaaaa@users.noreply.github.com> Date: Wed, 1 Nov 2023 14:28:35 -0700 Subject: [PATCH] Docs: Add user consent section (#184) * docs: add user consent section * Update README.md Co-authored-by: Saul Carlin --------- Co-authored-by: Saul Carlin --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 1857c5b2..0900249b 100644 --- a/README.md +++ b/README.md @@ -267,6 +267,18 @@ let decodedConversation = containerAgain.decode(with: client) try await decodedConversation.send(text: "hi") ``` +## 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, another 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). + ## Handle different content types All of the send functions support `SendOptions` as an optional parameter. The `contentType` option allows specifying different types of content other than the default simple string standard content type, which is identified with content type identifier `ContentTypeText`.