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 support@ekline.io.

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: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: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:32Z

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

github-actions · 2025-04-15T13:36:21Z

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 5d8addc

|`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-16T12:10:01Z

Published docs preview URL: https://devrev-preview-0ec0bde2-4238-4879-b860-75d745afd51a.docs.buildwithfern.com

github-actions · 2025-05-05T10:17:30Z

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 7abec7b

|`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-05-05T10:17:47Z

Published docs preview URL: https://devrev-preview-8d5e634f-2b1f-42c3-8924-c8aea750b557.docs.buildwithfern.com

github-actions · 2025-05-05T10:18:56Z

Published docs preview URL: https://devrev-preview-72edeebb-b8a0-4943-b983-c72645aa8174.docs.buildwithfern.com

Remove frontend id method

github-actions · 2025-05-20T05:18:01Z

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

⚠️ [EkLine]

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 2099d32

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-05-20T05:18:11Z

Published docs preview URL: https://devrev-preview-a7c2b74d-5b05-45d4-96fb-eb6a38273774.docs.buildwithfern.com

github-actions · 2025-05-20T06:09:00Z

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

⚠️ [EkLine]

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 408b794

|`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-05-20T06:09:25Z

Published docs preview URL: https://devrev-preview-94240239-831f-4a15-a181-14921acc0f26.docs.buildwithfern.com

method getSessionDetails() added

6f458b8

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

add isSearchAgentOpen method

1daabd8

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

Update search.mdx

5d7980f

add bind hotkey example

shalomgk and others added 4 commits April 11, 2025 10:51

Update search.mdx

f15a885

Update user-identity.mdx

433a286

Merge branch 'main' into update-plug-sdk-methods

e5e583f

Update method descriptions for consistency

5d8addc

github-actions bot reviewed Apr 15, 2025

View reviewed changes

Atul-Butola added 2 commits April 16, 2025 15:38

Merge branch 'main' into update-plug-sdk-methods

4090b69

Update search.mdx

c470226

Update user-identity.mdx

7abec7b

github-actions bot reviewed May 5, 2025

View reviewed changes

Update search.mdx

2508efa

Update user-identity.mdx

2099d32

Remove frontend id method

github-actions bot reviewed May 20, 2025

View reviewed changes

Merge branch 'main' into update-plug-sdk-methods

408b794

github-actions bot reviewed May 20, 2025

View reviewed changes

shalomgk merged commit 0e1a788 into main May 20, 2025
5 checks passed

shalomgk deleted the update-plug-sdk-methods branch May 20, 2025 07:39

	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.

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

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

Uh oh!

Conversation

shalomgk commented Apr 3, 2025

Uh oh!

github-actions bot commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌟 EkLine Reviewer

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

github-actions bot commented Apr 3, 2025

Uh oh!

bc-devrev left a comment

Choose a reason for hiding this comment

Uh oh!

bc-devrev Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

bc-devrev Apr 3, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 4, 2025

Uh oh!

github-actions bot commented Apr 4, 2025

Uh oh!

github-actions bot Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 16, 2025

Uh oh!

github-actions bot May 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

github-actions bot commented May 5, 2025

Uh oh!

github-actions bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 20, 2025

Uh oh!

github-actions bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 20, 2025

Uh oh!

Uh oh!

Uh oh!

WIP method getSessionDetails() added #194

WIP method getSessionDetails() added #194

github-actions bot commented Apr 3, 2025 •

edited

Loading