Update methods.mdx #86

Atul-Butola · 2024-08-29T05:11:20Z

ISS-94327

Spelling.

This reverts commit 60736a4.

github-actions · 2024-09-16T22:31:24Z

Published docs preview URL: https://devrev-preview-66d46d45-4fea-4eb4-ae9b-5571095b4047.docs.buildwithfern.com

github-actions · 2024-09-23T06:35:33Z

Published docs preview URL: https://devrev-preview-fcc3d810-2d64-41f8-a160-94f131b42d73.docs.buildwithfern.com

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

bc-devrev · 2024-09-23T17:47:54Z

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

-window.plugSDK.toggleWidget(true);
-window.plugSDK.toggleSearchAgent(true);
+plugSDK.toggleWidget(true, 'create_conversation', {
+startConversationContent: 'Hi',


Indent.

Suggested change

startConversationContent: 'Hi',

startConversationContent: 'Hi',

github-actions · 2024-10-01T11:39:45Z

Published docs preview URL: https://devrev-preview-77b936ea-e175-4c69-9b69-61d3cb3a440e.docs.buildwithfern.com

github-actions · 2024-10-01T11:40:07Z

Published docs preview URL: https://devrev-preview-12515243-d60c-4216-8ca0-aaaa6d18569d.docs.buildwithfern.com

github-actions · 2024-10-09T11:22:20Z

Published docs preview URL: https://devrev-preview-7bb89ab6-b4ac-47c9-863e-a03e86ae83d2.docs.buildwithfern.com

github-actions · 2024-10-09T11:35:57Z

Published docs preview URL: https://devrev-preview-843a230c-41ce-4260-944f-9e70f0296002.docs.buildwithfern.com

github-actions · 2024-10-09T15:26:59Z

Published docs preview URL: https://devrev-preview-b9d68904-3678-401e-a54c-3b96fe0afbe8.docs.buildwithfern.com

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

github-actions · 2024-10-09T23:22:00Z

🌟 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 · 2024-10-09T23:22:02Z

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


- `ON_PLUG_WIDGET_CLOSED` The PLuG widget is closed.
+<Callout intent="note">
+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.


📝 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

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

Suggested change

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.

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

github-actions · 2024-10-09T23:22:02Z

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

+
+## Track events
+
+To track user events using PLuG, utilize the `trackEvent` method available in the PLuG SDK. This method automatically links the event to the active user profile within the widget. For more details on user identification within the PLuG widget, refer to [Identify your users with PLuG](https://devrev.ai/docs/plug/identify-web-user).


🚫 [EkLine] _{reported by reviewdog 🐶}

Confirm the link. The URL 'https://devrev.ai/docs/plug/identify-web-user' seems inaccessible with error code 404. It might be incorrect or improperly formatted. (EK20001)

github-actions · 2024-10-09T23:22:02Z

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

+|`enable_session_recording`   |Instructs the widget to determine whether to start the session recording.   |Boolean (True or False)   |
+|`session_token`   |Identifies the user interacting with your app.   |String   |
+|`primary_text_color`   |The color of the launcher, button text for new tickets and conversations, conversation user text, and more. It must be a valid hex color code, such as `#f0f0f0`.    |String   |
+|`session_recording_options`    |Options for recording observability sessions.   |Refer to [Session recording options](https://devrev.ai/docs/plug/session-recording)    |


🚫 [EkLine] _{reported by reviewdog 🐶}

Confirm the link. The URL 'https://devrev.ai/docs/plug/session-recording' seems inaccessible with error code 404. It might be incorrect or improperly formatted. (EK20001)

github-actions · 2024-10-09T23:22:50Z

Published docs preview URL: https://devrev-preview-4531b68d-9ee3-4a8b-b663-d7daca0fab2e.docs.buildwithfern.com

github-actions · 2024-10-09T23:24:48Z

Published docs preview URL: https://devrev-preview-9db144aa-e12c-43b8-a82a-49f8b740010c.docs.buildwithfern.com

github-actions · 2024-10-09T23:32:49Z

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

+|`primary_text_color`   |The color of the launcher, button text for new tickets and conversations, conversation user text, and more. It must be a valid hex color code, such as `#f0f0f0`.    |String   |
+|`session_recording_options`    |Options for recording observability sessions.   |Refer to [Session recording options](https://devrev.ai/docs/plug/session-recording)    |
+|`accent_color`   |The accent color of the PLuG affects the launcher, new ticket and conversation buttons, conversation user text, and more.   |String   |
+|`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)   |


🚫 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Use 'DevRev' instead of 'devrev'. (EK25050)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

|`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) |

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

github-actions · 2024-10-09T23:32:50Z

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

+|`session_recording_options`    |Options for recording observability sessions.   |Refer to [Session recording options](https://devrev.ai/docs/plug/session-recording)    |
+|`accent_color`   |The accent color of the PLuG affects the launcher, new ticket and conversation buttons, conversation user text, and more.   |String   |
+|`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)   |
+|`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;}`  |


🚫 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Use 'DevRev' instead of 'devrev'. (EK25050)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

|`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;}` |

|`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 is 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 · 2024-10-09T23:32:50Z

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

+|`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)   |
+|`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;}`  |
+|`theme`   |The color scheme for the launcher and widget.   |`light` or `dark`         |
+|`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   |


🚫 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Use 'DevRev' instead of 'devrev'. (EK25050)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

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

|`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 overrides the launcher setting. |left or right |

github-actions · 2024-10-09T23:33:58Z

Published docs preview URL: https://devrev-preview-ee931cdb-91f5-475c-bafc-628e91a573a8.docs.buildwithfern.com

Update methods.mdx

38c00b9

ISS-94327

Atul-Butola requested a review from a team as a code owner August 29, 2024 05:11

Atul-Butola marked this pull request as draft August 29, 2024 05:14

Atul-Butola added 8 commits August 29, 2024 11:06

Update methods.mdx

283eacf

Update methods.mdx

ffc5047

Update methods.mdx

b3f6a30

Update methods.mdx

1b7b88c

Update methods.mdx

abeba81

Update methods.mdx

3bf6d3d

Update methods.mdx

dc9ece0

Update methods.mdx

7ce8f73

Atul-Butola changed the title **WIP** Update methods.mdx Update methods.mdx Sep 13, 2024

Atul-Butola marked this pull request as ready for review September 13, 2024 09:38

Atul-Butola added 3 commits September 13, 2024 15:08

Merge branch 'main' into SDK-methods

288a9d0

Update methods.mdx

3cd5fd6

Update methods.mdx

72dd608

Atul-Butola requested review from bc-devrev, kunal-mohta-99 and shalomgk September 13, 2024 09:52

nikhiltidke101 and others added 6 commits September 13, 2024 17:05

Update methods.mdx

5c70088

Update methods.mdx

d743484

Spelling.

fixed spelling and capitalization

5b7e8d4

Fern upgrade

60736a4

tagged code phrase

d781684

Revert "Fern upgrade"

a5698c7

This reverts commit 60736a4.

Atul-Butola and others added 3 commits September 17, 2024 19:04

Update methods.mdx

679d52e

Merge branch 'main' into SDK-methods

3c02c23

Update methods.mdx

f27f417

bc-devrev requested changes Sep 23, 2024

View reviewed changes

Atul-Butola added 2 commits October 1, 2024 17:06

Update methods.mdx

83b1474

Merge branch 'main' into SDK-methods

f391a66

Atul-Butola added 5 commits October 1, 2024 18:09

Update methods.mdx

5ec043e

Update methods.mdx

a37274c

Update methods.mdx

0a333fd

Update methods.mdx

7e0309b

Update methods.mdx

4dea131

Update methods.mdx

a003537

Atul-Butola requested a review from bc-devrev October 9, 2024 11:39

Update methods.mdx

e818634

bc-devrev requested changes Oct 9, 2024

View reviewed changes

Update methods.mdx

84c7a72

github-actions bot reviewed Oct 9, 2024

View reviewed changes

Merge branch 'main' into SDK-methods

31c1e84

Update methods.mdx

faa801a

github-actions bot reviewed Oct 9, 2024

View reviewed changes

Atul-Butola requested a review from bc-devrev October 10, 2024 11:51

bc-devrev approved these changes Oct 10, 2024

View reviewed changes

Atul-Butola merged commit ead3e62 into main Oct 10, 2024
3 checks passed

Atul-Butola deleted the SDK-methods branch October 10, 2024 23:09

	startConversationContent: 'Hi',
	startConversationContent: 'Hi',

	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.
	Once the `shutdown()` method is called, all other widget functionalities, such as session recording and Nudges, also stop. You need to reinitialize the widget to reactivate these features.


		## Track events

		To track user events using PLuG, utilize the `trackEvent` method available in the PLuG SDK. This method automatically links the event to the active user profile within the widget. For more details on user identification within the PLuG widget, refer to [Identify your users with PLuG](https://devrev.ai/docs/plug/identify-web-user).

	\|`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) \|
	\|`custom_launcher_selector` \|A CSS selector string is used to match the element to which the widget attaches. You can also set this selector from the PLuG settings on app.DevRev.ai. If both sources are set, this value is considered the definitive source. \|Boolean (True or False) \|

	\|`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;}` \|
	\|`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 is 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;}` \|

	\|`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 \|
	\|`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 overrides the launcher setting. \|left or right \|

Update methods.mdx #86

Update methods.mdx #86

Uh oh!

Conversation

Atul-Butola commented Aug 29, 2024

Uh oh!

github-actions bot commented Sep 16, 2024

Uh oh!

github-actions bot commented Sep 23, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bc-devrev Sep 23, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌟 EkLine Reviewer

Uh oh!

github-actions bot Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 9, 2024

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 9, 2024 •

edited

Loading