📋Whiteboard

A Whiteboard is associated to each of your Potico Rooms. Users can interact on the whiteboard, and read your announcements.

Get Announcements

Announcements are pinned on the whiteboard and can only be posted by the room owner.

const announcement = await proticoAPI.whiteboard.getAnnouncement(room);

Parameters description

Parameter	Description	Type
room	Whiteboard room ID	string

Get Whiteboard Messages

User messages in the given room. Can also be filtered by user address or message ID.

type WhiteboardHistoryParams = {
  room: string;
  address?: string;
  referenceMessageId?: string;
};

const messages = await proticoAPI.whiteboard.getMessages(params:WhiteboardHistoryParams);

Parameters description

Parameter	Description	Type
room	Whiteboard room ID	string
address	User Address	string (optional)
referenceMessageId	Message ID	string (optional)

Post Whiteboard Message

await proticoAPI.whiteboard.postMessage(data,room,domain,roomUrl);

Parameters description

Parameter	Description	Type
data	message data	object
room	Whiteboard room ID	string
domain	Your domain	string
roomUrl	Current room URL	string