[NEW] Additional Livechat iFrame API's

[renatobecker-zz]

Closes #10866

This PR adds new Livechat iFrame API's, as described below:

• setGuestToken(token):
  Using this method a new Livechat session will be created using a external token (e.g.):
  RocketChat(function() { this.setGuestToken('FHwaLnp8fzjMupSAj'); });

• setGuestName(name):
  This method assigns a name to the Livechat active session visitor. If the visitor is already registered, its name will be updated in the database. If the visitor is not yet registered, its name will be assigned when the registration method is called.(e.g.):
  RocketChat(function() { this.setGuestName('Rocket.Chat visitor name'); });

• setGuestEmail(email):
  This method assigns an email to the Livechat active session visitor. If the visitor is already registered, its email will be updated in the database. If the visitor is not yet registered, its email will be assigned when the registration method is called.(e.g.):
  RocketChat(function() { this.setGuestEmail('rocket@rocket.chat'); });

• registerGuest(data):
  This method checks if there is a Livechat visitor with the same token passed by the object. If a Livechat visitor does not exist, a new Livechat visitor will be created or, if one exists, will be updated. After that, a new Livechat session will be started.(e.g.):
  RocketChat(function() { this.registerGuest({token: 'pSjpaw46CeL6Zu9f9', name: 'Rocket.Chat visitor name', email: 'rocket@rocket.chat'}); });
  Or without a token:
  RocketChat(function() { this.registerGuest({name: 'Rocket.Chat visitor name', email: 'rocket@rocket.chat'}); });

[Leen15]

Hi guys, any ETA for this?

[sampaiodiego]

@Leen15 it will be released on 0.66

[sampaiodiego]

@renatobecker can you please add the new events to our docs as well? https://github.com/RocketChat/docs/tree/master/developer-guides/livechat-api

[renatobecker-zz]

@sampaiodiego,
I have sent the Livechat API documentation changes for approval.
Thanks.

[sampaiodiego]

general considerations:

• when calling setGuestToken I get an error because it is trying to insert a department record which was already added:

• after calling setGuestName and setGuestEmail I would expect to see the values on the register form (pre-filled)

[sampaiodiego]

please change to if (typeof data !== 'object') { to help readability

[sampaiodiego]

you don't need to use this much parenthesis.. without them the code looks much clearer:

if (!token || token === this.token.get()) {

[sampaiodiego]

on pull request #10767 this method will return the whole visitor object, I think you can to the same here (it should avoid future conflicts)

[sampaiodiego]

this does not have the desired effect. on my tests after changing the token using setGuestToken, I'm still receiving messages from the old room/token and being notified as well.

[renatobecker-zz]

@sampaiodiego, the changes requested has been submitted.
I want to say that even calling this method https://github.com/RocketChat/Rocket.Chat/pull/10918/files#diff-11b7d22c1f403eeeb1b94248bf66adcaR22 when a new session is created, if the agent keeps sending messages in the unused room, this events are still being emitted to Livechat websocket.

[sampaiodiego]

any reason to not use Livechat.guestName directly on helper instead of creating this reactive var?

[sampaiodiego]

you can use Livechat.guestName directly here, instead of using the reactive var

[renatobecker-zz]

@sampaiodiego, I fixed the usage of ReactiveVar's on register helpers.
Sorry, my mistake.

[sampaiodiego]

I think this is the same case as Livechat.guestName I've talked before (sry for not have seen this before). Any reason to use a ReactiveVar here instead of keeping Livechat. agent ?

[renatobecker-zz]

Hi @sampaiodiego!
I fixed the ReactiveVar stuff.. The last one was the same as the others you have seen before.
My mistake.

[salviof]

Please, we need this too:
#13583