Privacy List
Learn how to create privacy lists and implement user-to-user blocks.
Privacy list API allows enabling or disabling communication with other users in a chat. You can create, modify, delete privacy lists or define a default list.
The user can have multiple privacy lists, but only one can be active.
Visit our Key Concepts page to get an overall understanding of the most important QuickBlox concepts.
Before you begin
- Register a QuickBlox account. This is a matter of a few minutes and you will be able to use this account to build your apps.
- Configure QuickBlox SDK for your app. Check out our Setup page for more details.
- Create a user session to be able to use QuickBlox functionality. See our Authentication page to learn how to do it.
- Connect to the Chat server. See our Connection page to learn how to do it.
Create privacy list
A privacy list must have at least one element in order to be created. If no elements are specified, then the list with a given name will be deleted.
The QBPrivacyListItem
class takes 4 arguments:
- type - use
USER_ID
to block a user in a 1-1 chat orGROUP_USER_ID
to block in a group chat. - valueForType - ID of a user to apply an action.
- allow - can be
true
orfalse
. - mutualBlock - can be
true
orfalse
to block user’s message in both directions or not.
In order to be used the privacy list should be not only set but also activated (set as default).
Activate privacy list
In order to activate rules from a privacy list, you should set it as default.
Update privacy list
There are some rules you should follow to update a privacy list:
- Include all of the desired items (not a “delta”).
- If you want to update or set a new privacy list instead of the current one, you should decline the current default list first.
Retrieve privacy lists
To get a list of all your privacy lists names, use the following request.
Retrieve privacy list by name
To get the privacy list by name, you should use the following method.
Remove privacy list
To delete a list, you can call a method below or you can edit a list and set items to nil
.
Before deleting the privacy list, you should decline it.
Blocked user attempts to communicate with user
A user can be blocked in 1-1 dialog and group dialog. In this case, the blocked user receives an error when trying to send a message in a 1-1 dialog and receives nothing when trying to send a message in group dialog.
Was this page helpful?