🚀
ProticoSDK
  • 👋Welcome to Protico
  • Overview
    • 💡What we do
    • ✨Our Features
  • SDK
    • 🛠️Getting started
    • 📝Web3 Providers
      • Use existing provider
      • Initialize ProticoAuthCore
        • MetaMask
        • WalletConnect
        • Web3Auth
      • Login
      • Full example
    • 🧑Interact with Ceramic
      • Setting up Ceramic
      • 👤Profile
      • 🤝Contacts
    • Use Protico APIs
      • ⚙️Settings
      • 📋Whiteboard
      • 🗒️Announcement
      • ▪️Blocklist
    • 🔑User Keys
      • Encryption / Decryption
    • Considerations
      • Protico API Key
      • Rate Limiting
Powered by GitBook
On this page
  • Get Blocklist
  • Parameters description
  • Get One from Blocklist
  • Parameters description
  • Add One to Blocklist
  • Parameters description
  • Delete One from Blocklist
  • Parameters description
  • Update One in the Blocklist
  • Parameters description
  1. SDK
  2. Use Protico APIs

Blocklist

You can block some users on your whiteboard, by adding their addresses to the blocklist.

Get Blocklist

This will get the whole blocklist for the given domain.


interface BlocklistItem {
  address: string;
  reason: string;
  created_by: string;
  updated_by: string;
  created_at: string;
  updated_at: string;
}


const blocklist : BlocklistItem[] = await proticoAPI.blocklist.get(domain:string);

Parameters description

Parameter
Description
Type

domain

Current domain

string

Get One from Blocklist

To get information about a particular address in the blocklist

const blocklist : BlocklistItem = await proticoAPI.blocklist.getOne(domain:string,address:string);

Parameters description

Parameter
Description
Type

domain

Current domain

string

address

Address of the account being blocked

string

Add One to Blocklist

To get information about a particular address in the blocklist

const blocklist : BlocklistItem[] = await proticoAPI.blocklist.addOne(domain:string,data:Partial<BlocklistItem>);

Parameters description

Parameter
Description
Type

domain

Current domain

string

data.address

Address of the account being blocked

string

data.reason

Reason for adding the account to the blocklist

string

Delete One from Blocklist

Remove one address from the blocklist.

const blocklist : BlocklistItem = await proticoAPI.blocklist.deleteOne(domain:string,address:string);

Parameters description

Parameter
Description
Type

domain

Current domain

string

address

Address of the account being blocked

string

Update One in the Blocklist

To update information about a particular address in the blocklist

const blocklist : BlocklistItem = await proticoAPI.blocklist.updateOne(domain:string,address:string,data:Partial<BlocklistItem>);

Parameters description

Parameter
Description
Type

domain

Current domain

string

address

Address of the account being blocked

string

data.reason

Reason for adding the account to the blocklist

string

PreviousAnnouncementNextUser Keys

Last updated 1 year ago

▪️