Focus Beeper Desktop app

client.focus(?, ?): FocusResponse { success }

POST/v1/focus

Focus Beeper Desktop and optionally navigate to a specific chat, message, or pre-fill draft text and attachment.

ParametersExpand Collapse

body: FocusParams { chatID, draftAttachmentPath, draftText, messageID }

chatID?: string

Optional Beeper chat ID (or local chat ID) to focus after opening the app. If omitted, only opens/focuses the app.

draftAttachmentPath?: string

Optional draft attachment path to populate in the message input field.

draftText?: string

Optional draft text to populate in the message input field.

messageID?: string

Optional message ID. Jumps to that message in the chat when opening.

ReturnsExpand Collapse

FocusResponse { success }

Response indicating successful app focus action.

success: boolean

Whether the app was successfully opened/focused.

Focus Beeper Desktop app

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop();

const response = await client.focus();

console.log(response.success);

{
  "success": true
}

Returns Examples

{
  "success": true
}