SCAL-304413: Add TSE event for RefreshLiveboardBrowserCache#497
SCAL-304413: Add TSE event for RefreshLiveboardBrowserCache#497ajeet-lakhani-ts wants to merge 1 commit intomainfrom
Conversation
ajeet-lakhani-ts
force-pushed
the
SCAL-304413--add-tse-event-for-lb-cache
branch
from
11e8d08 to
ec297f4
Compare
|
SonarQube Quality Gate
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces the RefreshLiveboardBrowserCache member to the EmbedEvent, HostEvent, and Action enums to support clearing the browser cache for Liveboard ChartViz containers. The review feedback correctly identifies that the JSDoc examples for these new members contain placeholder logic and irrelevant payload properties (such as sendToSelf) likely copied from existing events; these examples should be updated to accurately reflect the cache refresh functionality.
| * liveboardEmbed.on(EmbedEvent.RefreshLiveboardBrowserCache, (payload) => { | ||
| * console.log('Send test email', payload); | ||
| * // payload: { liveboardId: string, sendToSelf: boolean } | ||
| * }) |
There was a problem hiding this comment.
The example code for EmbedEvent.RefreshLiveboardBrowserCache contains a console.log message and payload description that appear to be copied from another event. The log message should be updated to be relevant to refreshing the cache, and the payload for this event likely does not include sendToSelf.
| * liveboardEmbed.on(EmbedEvent.RefreshLiveboardBrowserCache, (payload) => { | |
| * console.log('Send test email', payload); | |
| * // payload: { liveboardId: string, sendToSelf: boolean } | |
| * }) | |
| * liveboardEmbed.on(EmbedEvent.RefreshLiveboardBrowserCache, (payload) => { | |
| * console.log('Liveboard browser cache refreshed', payload); | |
| * // payload: { liveboardId: string } | |
| * }) | |
| * @example | ||
| * ```js | ||
| * liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache, { | ||
| * sendToSelf: true, | ||
| * }) | ||
| * ``` | ||
| * @example | ||
| * ```js | ||
| * // Send to all recipients | ||
| * liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache, { | ||
| * sendToSelf: false, | ||
| * }) | ||
| * ``` |
There was a problem hiding this comment.
The examples for HostEvent.RefreshLiveboardBrowserCache seem to be copy-pasted from SendTestScheduleEmail. The sendToSelf payload and the comment // Send to all recipients are not relevant for an event that clears the browser cache. This event likely doesn't require a payload, and the two examples can be consolidated into one.
| * @example | |
| * ```js | |
| * liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache, { | |
| * sendToSelf: true, | |
| * }) | |
| * ``` | |
| * @example | |
| * ```js | |
| * // Send to all recipients | |
| * liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache, { | |
| * sendToSelf: false, | |
| * }) | |
| * ``` | |
| * @example | |
| * liveboardEmbed.trigger(HostEvent.RefreshLiveboardBrowserCache); | |
commit: |
1 participant
No description provided.