WIP method getSessionDetails() added #194

shalomgk · 2025-04-03T09:07:11Z

WorkItem: https://app.devrev.ai/devrev/works/ISS-161669

Add PLuG web SDK methods

getSessionDetails()
isSearchAgentOpen

github-actions · 2025-04-03T09:08:04Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

github-actions · 2025-04-03T09:08:08Z

fern/docs/pages/plug-sdk/web/methods.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/web/methods.mdx

Line 30 in 6f458b8

|`widget_alignment` |The PLuG widget can be positioned on either the left or right side of the launcher. You can also adjust the widget alignment through the PLuG settings at app.devrev.ai. If alignment settings are configured in both places, the value from app.devrev.ai will override the launcher setting. |left or right |

github-actions · 2025-04-03T09:08:24Z

Published docs preview URL: https://devrev-preview-f8dbb8ed-5802-4666-8e9d-446051557797.docs.buildwithfern.com

github-actions · 2025-04-03T09:11:29Z

Published docs preview URL: https://devrev-preview-a71d8d13-bdfe-4b11-96e9-e94b165bbde1.docs.buildwithfern.com

github-actions · 2025-04-03T09:11:35Z

fern/docs/pages/plug-sdk/web/methods.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/web/methods.mdx

Line 117 in 1daabd8

Once the `shutdown()` method is called, all other widget functionalities, such as session recording and Nudges, will also be stopped. You will need to reinitialize the widget to reactivate these features.

github-actions · 2025-04-03T09:26:07Z

Published docs preview URL: https://devrev-preview-755b88d4-e9d1-423c-a03e-0dbca4f1e7f0.docs.buildwithfern.com

github-actions · 2025-04-03T16:17:29Z

Published docs preview URL: https://devrev-preview-f406dd4e-30f2-4aa7-b5e6-b02f953b51ee.docs.buildwithfern.com

bc-devrev

Approved with a couple suggestions.

bc-devrev · 2025-04-03T17:54:33Z

fern/docs/pages/plug-sdk/web/methods.mdx

@@ -165,9 +175,17 @@ window.plugSDK.addSessionProperties({
 });
 ```

+## Get session details
+
+You can use the `getSessionDetails` method to fetch the session id and tab id of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session.


Suggested change

You can use the `getSessionDetails` method to fetch the session id and tab id of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session.

You can use the `getSessionDetails` method to fetch the session ID and tab ID of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session.

bc-devrev · 2025-04-03T17:55:00Z

fern/docs/pages/plug-sdk/web/methods.mdx

+window.plugSDK.isSearchAgentOpen
+```
+
+This returns true if the search agent is open and false if it is closed.


Suggested change

This returns true if the search agent is open and false if it is closed.

This returns `true` if the search agent is open and `false` if it is closed.

set identifier without session token

github-actions · 2025-04-04T05:04:07Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

+You can also pass the identifiers in the `plugSDK.init` option without generating the session token.
+
+<Callout intent="note">
+The frontend method, by its nature, is not secure as the data is transmitted through the client side. We recommend using the session token method to securely identify users.


📝 [EkLine] _{reported by reviewdog 🐶}

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

Suggested change

The frontend method, by its nature, is not secure as the data is transmitted through the client side. We recommend using the session token method to securely identify users.

The frontend method, by its nature, is not secure as the data is transmitted through the client side. The session token method is recommended to securely identify users.

github-actions · 2025-04-04T05:04:25Z

Published docs preview URL: https://devrev-preview-b0e7f95f-bb12-4f86-9ce0-0f5a0c11cc0c.docs.buildwithfern.com

add bind hotkey example

github-actions · 2025-04-04T05:54:07Z

fern/docs/pages/plug-sdk/web/search.mdx

+
+## Bind hotkey to toggleSearchAgent
+
+You can bind the `toggleSearchAgent` method to a hotkey, such as `Cmd + K` (or `Ctrl + K` for Windows), to toggle the search agent quickly. Here's an example implementation:


📝 [EkLine] _{reported by reviewdog 🐶}

Remove 'quickly' if it's not important to the meaning of the statement. (EK00006)

Suggested change

You can bind the `toggleSearchAgent` method to a hotkey, such as `Cmd + K` (or `Ctrl + K` for Windows), to toggle the search agent quickly. Here's an example implementation:

You can bind the `toggleSearchAgent` method to a hotkey, such as `Cmd + K` (or `Ctrl + K` for Windows), to toggle the search agent. Here's an example implementation:

github-actions · 2025-04-04T05:54:08Z

fern/docs/pages/plug-sdk/web/methods.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/web/methods.mdx

Line 27 in 5d7980f

|`custom_launcher_selector` |A CSS selector string is used to match the element to which the widget will be attached. You can also set this selector from the PLuG settings on app.devrev.ai. If both sources are set, this value will be considered the definitive source. |Boolean (True or False) |

github-actions · 2025-04-04T05:54:09Z

fern/docs/pages/plug-sdk/web/methods.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/web/methods.mdx

Line 28 in 5d7980f

|`spacing` |Padding from the launcher: This padding can also be set in the PLuG settings on app.devrev.ai. If a value is specified in both places, this value will be considered the definitive source. Bottom: Padding from the bottom of the launcher. Side: Spacing from the sides of the launcher |object `{bottom: string; side: string;}` |

github-actions · 2025-04-04T05:54:10Z

fern/docs/pages/plug-sdk/web/user-identity.mdx

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/plug-sdk/web/user-identity.mdx

Line 15 in 5d7980f

Ensure you copy your access token, as you will not be able to view it again.

github-actions · 2025-04-04T05:54:32Z

Published docs preview URL: https://devrev-preview-0cda0e61-8def-4e2b-a4ac-b77910b2d32d.docs.buildwithfern.com

method getSessionDetails() added

6f458b8

shalomgk requested a review from a team as a code owner April 3, 2025 09:07

github-actions bot reviewed Apr 3, 2025

View reviewed changes

add isSearchAgentOpen method

1daabd8

github-actions bot reviewed Apr 3, 2025

View reviewed changes

minor updates

f41ff97

shalomgk changed the title ~~method getSessionDetails() added~~ **WIP** method getSessionDetails() added Apr 3, 2025

Fixed user identity link

ce6ea40

bc-devrev approved these changes Apr 3, 2025

View reviewed changes

Update user-identity.mdx

e1497a6

set identifier without session token

github-actions bot reviewed Apr 4, 2025

View reviewed changes

Update search.mdx

5d7980f

add bind hotkey example

github-actions bot reviewed Apr 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP method getSessionDetails() added #194

WIP method getSessionDetails() added #194

shalomgk commented Apr 3, 2025

github-actions bot commented Apr 3, 2025 •

edited

Loading

github-actions bot Apr 3, 2025

github-actions bot commented Apr 3, 2025

github-actions bot commented Apr 3, 2025

github-actions bot Apr 3, 2025

github-actions bot commented Apr 3, 2025

github-actions bot commented Apr 3, 2025

bc-devrev left a comment

bc-devrev Apr 3, 2025

bc-devrev Apr 3, 2025

github-actions bot Apr 4, 2025

github-actions bot commented Apr 4, 2025

github-actions bot Apr 4, 2025

github-actions bot Apr 4, 2025

github-actions bot Apr 4, 2025

github-actions bot Apr 4, 2025

github-actions bot commented Apr 4, 2025

	You can use the `getSessionDetails` method to fetch the session id and tab id of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session.
	You can use the `getSessionDetails` method to fetch the session ID and tab ID of currently ongoing session. These details can then be passed across different domains to maintain the journey as a single, continuous session.

	This returns true if the search agent is open and false if it is closed.
	This returns `true` if the search agent is open and `false` if it is closed.

	The frontend method, by its nature, is not secure as the data is transmitted through the client side. We recommend using the session token method to securely identify users.
	The frontend method, by its nature, is not secure as the data is transmitted through the client side. The session token method is recommended to securely identify users.


		## Bind hotkey to toggleSearchAgent

		You can bind the `toggleSearchAgent` method to a hotkey, such as `Cmd + K` (or `Ctrl + K` for Windows), to toggle the search agent quickly. Here's an example implementation:

**WIP** method getSessionDetails() added #194

Are you sure you want to change the base?

**WIP** method getSessionDetails() added #194

Conversation

shalomgk commented Apr 3, 2025

github-actions bot commented Apr 3, 2025 • edited Loading

🌟 EkLine Reviewer

github-actions bot Apr 3, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 3, 2025

github-actions bot commented Apr 3, 2025

github-actions bot Apr 3, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 3, 2025

github-actions bot commented Apr 3, 2025

bc-devrev left a comment

Choose a reason for hiding this comment

bc-devrev Apr 3, 2025

Choose a reason for hiding this comment

bc-devrev Apr 3, 2025

Choose a reason for hiding this comment

github-actions bot Apr 4, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 4, 2025

github-actions bot Apr 4, 2025

Choose a reason for hiding this comment

github-actions bot Apr 4, 2025

Choose a reason for hiding this comment

github-actions bot Apr 4, 2025

Choose a reason for hiding this comment

github-actions bot Apr 4, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 4, 2025

WIP method getSessionDetails() added #194

WIP method getSessionDetails() added #194

github-actions bot commented Apr 3, 2025 •

edited

Loading