Consent

Consent records what a user wants to hear. Every conversation and inbox ID has one of three states.

State	Meaning	UI location
`unknown`	Nobody has decided	Requests
`allowed`	The user consented	Main inbox
`denied`	The user refused	Hidden

Consent belongs to the inbox. Device sync copies it to the user’s other installations.

State changes

Trigger	State
A peer starts a conversation	`unknown`
The user creates a conversation	`allowed`
The user sends a message	`allowed`
The app accepts or subscribes	`allowed`
The app blocks or unsubscribes	`denied`
The user is re-added to a group they left	`unknown`

The user’s creation of the conversation with the contact is considered consent.

The user’s response to the conversation is considered consent.

Sending a message sets the conversation to allowed from any prior state, including denied. Prevent sending in a denied conversation unless the user explicitly reverses the block.

Task	Browser, Node	Kotlin, Swift
Read conversation	`conversation.consentState()`	`conversation.consentState()`
Read by conversation ID	`preferences.getConsentState(GroupId, id)`	`preferences.conversationState(id)`
Read by inbox ID	`preferences.getConsentState(InboxId, id)`	`preferences.inboxIdState(id)`
Set conversation	`conversation.updateConsentState(state)`	`conversation.updateConsent(state)`
Set many	`preferences.setConsentStates(records)`	`preferences.setConsentState(entries)`
Stream changes	`preferences.streamConsent()`	`preferences.streamConsent()`

Batch state changes when possible. One batch produces one device-sync message.

  const 
const stream: AsyncStreamProxy<Consent[]>
stream = await 
client: Client<BuiltInContentTypes>
client.
Client<BuiltInContentTypes>.preferences: Preferences
Gets the preferences manager for this client
preferences.
Preferences.streamConsent(options?: StreamOptions<Consent[]>): Promise<AsyncStreamProxy<Consent[]>>
Creates a stream of consent state updates
@param ― options - Optional stream options
@returns ― Stream instance for consent updates
streamConsent({
    
onValue?: ((value: Consent[]) => void | Promise<void>) | undefined
Called when a value is emitted from the stream.
For message streams, this selects callback mode. Do not also iterate that stream.
Message delivery is acknowledged after this callback returns successfully.
onValue: 
handleConsent: (consent: Consent[]) => void
handleConsent,
  });

  const 
const stream: AsyncStreamProxy<Consent[]>
stream = await 
client: Client<BuiltInContentTypes>
client.
Client<BuiltInContentTypes>.preferences: Preferences
Gets the preferences manager for this client
@throws ― {ClientNotInitializedError} if the client is not initialized
preferences.
Preferences.streamConsent(options?: StreamOptions<Consent[]>): Promise<AsyncStreamProxy<Consent[]>>
Creates a stream of consent state updates
@param ― options - Optional stream options
@returns ― Stream instance for consent updates
streamConsent({
    
onValue?: ((value: Consent[]) => void | Promise<void>) | undefined
Called when a value is emitted from the stream.
For message streams, this selects callback mode. Do not also iterate that stream.
Message delivery is acknowledged after this callback returns successfully.
onValue: 
handleConsent: (consent: Consent[]) => void
handleConsent,
  });

client.preferences.streamConsent().collect(::handleConsent)

for try await consent in client.preferences.streamConsent() {
  handleConsent(consent)
}

See who added the user

Use conversation.addedByInboxId on Browser and Node. Use group.addedByInboxId() on Kotlin and Swift. creatorInboxId() is available on groups on all four SDKs.

Consent

State changes

Consent API

See who added the user