Guest shares API

Classes

GuestSharesApi

Guest links to a thread: one unauthenticated browser watches the thread over T3 Connect and proposes messages that the owner sends or dismisses. The thread record's guestShare holds the share, and a shell row's pendingGuestMessageCount counts the waiting messages. The server setting guestSharingEnabled is off by default. Off, create rejects with disabled and existing links pause.

GuestSharesApi

Guest links to a thread: one unauthenticated browser watches the thread over T3 Connect and proposes messages that the owner sends or dismisses. The thread record’s guestShare holds the share, and a shell row’s pendingGuestMessageCount counts the waiting messages. The server setting guestSharingEnabled is off by default. Off, create rejects with disabled and existing links pause.

Kind: global class

• GuestSharesApi
  • .create()
  • .close()
  • .sendMessage()
  • .dismissMessage()

guestSharesApi.create()

Open a 24 hour guest link. It replaces the thread’s earlier link. The url holds the guest’s credential, so treat it as a secret. A refusal rejects with a T3RpcError whose GuestShareCreateError record has a reason, such as disabled or connect_unavailable. Needs access:write.

create(threadId: ThreadId, signal?: AbortSignal): Promise<GuestShareCreateResult>;

Kind: instance method of GuestSharesApi

guestSharesApi.close()

Revoke the thread’s link. Resolves when the thread has no link.

async close(threadId: ThreadId, signal?: AbortSignal): Promise<void>;

Kind: instance method of GuestSharesApi

guestSharesApi.sendMessage()

Send a pending guest message to the agent, after any active run. The server uses the guest’s text and files, and names the guest in the text that the agent reads. Returns the id of the new user message. A message that is not pending rejects.

async sendMessage(
    threadId: ThreadId,
    guestMessageId: GuestMessageId,
    signal?: AbortSignal,
  ): Promise<MessageId>;

Kind: instance method of GuestSharesApi

guestSharesApi.dismissMessage()

Dismiss a pending guest message. A message that is not pending rejects.

async dismissMessage(
    threadId: ThreadId,
    guestMessageId: GuestMessageId,
    signal?: AbortSignal,
  ): Promise<void>;

Kind: instance method of GuestSharesApi