Skip to main content
reference

PublicConnection

Provides a wrapper for functions used in public connection ( created using `Endpoint.connectPublic).

Constructors

constructor

constructor(platform: Endpoint)

NameTypeDescription
platformEndpoint

Methods

getInboxPublicView

Fetches Inbox public view.

async getInboxPublicView(inboxId: string)

NameTypeDescription
inboxIdstringID of Inbox to get public meta

TypeDescription
Promise<InboxPublicView>

sendDataToInbox

Sends data and optional files to an Inbox.

async sendDataToInbox(inboxId: string, entry: InboxEntryPayload)

NameTypeDescription
inboxIdstringID of Inbox to send the entry to
entryInboxEntryPayload`InboxEntryPayload` object

TypeDescription
Promise<void> a promise that resolves when the data and files have been successfully sent to the Inbox