I am going to use User.logOut() of Embedded Framework.
However, there was no explanation for logOut() in the documentation, so I asked the customer care team, but I did not receive a clear answer.
I confirmed that User.logOut() is operating normally.
Is it okay to use this function?
And if you don't mind, can you update the documentation for us?
Logout isn't an action, but rather a notification that comes across when you subscribe to the "user" namespace: https://developer.genesys.cloud/api/embeddable-framework/actions/subscribe
Supported actions (i.e. functions you can invoke from your code to affect change within the embeddable framework) are documented here: https://developer.genesys.cloud/api/embeddable-framework/actions/
Anything that is not included in this documentation "may" work, but is not officially supported and may change without notice.
If you're looking to setup your own logout capabilities from your app, you'll want to explore the documentation for authorization: https://developer.genesys.cloud/api/rest/authorization/
Thank you for your answer.
But I already know the document.
If possible, please refer to my Case (Case No.0003041060).
I am using the logout function as follows through postMassage provided by Embedded Framework.
If another method is used, the Softphone of the Embedded Framework cannot completely logout normally.
If you press the logout button in the Embedded Softphone, you can see that you are using window.PureCloud.User.logOut() function.
What we want is an explanation of User.logOut() missing in the document (https://developer.genesys.cloud/api/embeddable-framework/actions/User/).
We have already verified the operation of User.logOut() and also confirmed that the same result cannot be produced in other ways.
This statement was the most relevant part of what I previously wrote, because it's not an officially supported feature for the embeddable framework. It may be something that "we" use, but if it is not announced as a released feature and documented, then it's not a supported feature. The act of announcing a feature and publicly documenting is is what qualifies things for inclusion under the change notification policy; anything that is not included in that public documentation is not applicable under that policy.
Can you ask the document management team if the content is missing?
No, the content isn't "missing". It is deliberately not there, as this is not a supported feature. Again, there are features and APIs that may be used by Genesys developed applications that are not publicly released/available; anything that falls in to this category is deliberately excluded from our documentation, and are not covered by the change management policy. Just because you're able to locate something using console/network monitoring does not automatically mean that it is a documented/supported feature.
If this is something you would like to see added as an "officially supported" feature, I suggest voting for it in the ideas portal.
This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.