"use strict";
import {InvitationsService} from "./InvitationsService";
import {XMPPUTils} from "../common/XMPPUtils";
import {ErrorManager} from "../common/ErrorManager";
import {Contact, NameUpdatePrio} from "../common/models/Contact";
import * as util from 'util';
import * as md5 from 'md5';
import * as path from 'path';
import {getRandomInt, isStarted, logEntryExit} from "../common/Utils";
import {PresenceService} from "./PresenceService";
import {EventEmitter} from "events";
import {Logger} from "../common/Logger";
import {Core} from "../Core";
import {PresenceLevel, PresenceRainbow, PresenceShow, PresenceStatus} from "../common/models/PresenceRainbow";
import {Invitation} from "../common/models/Invitation";
import {GenericService} from "./GenericService";
import {PEERTYPE} from "../common/models/Conversation.js";
import {isObject, isString} from "../common/Utils";
let AsyncLock = require('async-lock');
export {};
const LOG_ID = "CONTACTS/SVCE - ";
const API_ID = "API_CALL - ";
class RosterPresenceQueue {
private _logger : Logger;
private _rosterPresenceQueue: any;
private _contactsService : ContactsService;
constructor(_logger : Logger, _contacts: ContactsService) {
let that = this;
that._logger = _logger;
that._contactsService = _contacts;
that._rosterPresenceQueue = [];
// timeout: 5000, Specify timeout - max amount of time an item can remain in the queue before acquiring the lock
// maxPending: 1000, Set max pending tasks - max number of tasks allowed in the queue at a time
// maxOccupationTime : 3000 Specify max occupation time - max amount of time allowed between entering the queue and completing execution
that.lockEngine = new AsyncLock({timeout: 3 * 60 * 1000, maxPending: 1000, maxOccupationTime : 5 * 60 * 1000});
}
//region Lock
async lock(fn, id) {
let that = this;
let resultLock = "Lock failed.";
try {
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(lock) - id : ", id, " - will acquire lock the ", that.lockKey);
await that.lockEngine.acquire(that.lockKey, async () => {
// that._logger.log(that._contacts.DEBUG, LOG_ID + "(lock) lock the ", that.lockKey);
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(lock) - id : ", id, " - lock the ", that.lockKey);
let result = undefined;
try {
result = await fn(); // async work
return result;
} catch (err3) {
that._logger.log(that._contactsService.ERROR, LOG_ID + "(lock) - id : ", id, " - CATCH Error !!! error at run : ", that.lockKey, ", error : ", err3);
}
}).then((result) => {
// that._logger.log(that.DEBUG, LOG_ID + "(lock) release the ", that.lockKey);
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(lock) - id : ", id, " - release the ", that.lockKey, ", result : ", result);
resultLock = result;
}).catch((err2) => {
that._logger.log(that._contactsService.WARN, LOG_ID + "(lock) - id : ", id, " - catch at acquire : ", that.lockKey, ", error : ", err2);
throw resultLock = err2;
}
);
} catch (err) {
that._logger.log(that._contactsService.ERROR, LOG_ID + "(lock) - id : ", id, " - CATCH Error !!! error at acquire : ", that.lockKey, ", error : ", err);
throw resultLock = err;
}
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(lock) - id : ", id, " - __ exiting __ ", that.lockKey, ", resultLock : ", resultLock);
return resultLock;
}
//endregion Lock
add( presenceToSave : {presence : any, date: any }){
let that = this;
let id = (new Date()).getTime();
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(add) - id : ", id, " - will lock.");
that.lock(() => {
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(add) - id : ", id, " - will call fn for presence.jid : ", presenceToSave.presence.jid);
this._rosterPresenceQueue.push(presenceToSave);
}, id).then(() => {
that._logger.log(that._contactsService.DEBUG, LOG_ID + "(add) - id : ", id, " - lock succeed.");
}).catch((error) => {
that._logger.log(that._contactsService.ERROR, LOG_ID + "(add) - id : ", id, " - Catch Error, error : ", error);
});
}
treatPresenceForContact(contact: any, fn) {
let that = this;
let id = (new Date()).getTime();
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(treatPresenceForContact) - id : ", id, " - will lock.");
that.lock(() => {
that._rosterPresenceQueue.filter(presenceItem => presenceItem.presence.jid===contact.jid).forEach(item => {
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(treatPresenceForContact) - id : ", id, " - will call treat presence : ", item.presence, " for contact.jid : ", contact.jid);
fn(item.presence);
});
let currentDate = Date.now();
that._rosterPresenceQueue = that._rosterPresenceQueue.filter(presenceItem => presenceItem.presence.jid!==contact.jid || (presenceItem.date + 10000) < currentDate);
}, id).then(() => {
that._logger.log(that._contactsService.DEBUG, LOG_ID + "(treatPresenceForContact) - id : ", id, " - lock succeed.");
}).catch((error) => {
that._logger.log(that._contactsService.ERROR, LOG_ID + "(treatPresenceForContact) - id : ", id, " - Catch Error, error : ", error);
});
}
treatPresenceForAllContacts(fn) {
let that = this;
let id = (new Date()).getTime();
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(treatPresenceForAllContacts) - id : ", id, " - will lock.");
that.lock(() => {
that._rosterPresenceQueue.forEach(item => {
that._logger.log(that._contactsService.INTERNAL, LOG_ID + "(treatPresenceForAllContacts) - id : ", id, " - will call fn for presence.jid : ", item.presence.jid);
fn(item.presence);
});
let currentDate = Date.now();
that._rosterPresenceQueue = [];
}, id).then(() => {
that._logger.log(that._contactsService.DEBUG, LOG_ID + "(treatPresenceForAllContacts) - id : ", id, " - lock succeed.");
}).catch((error) => {
that._logger.log(that._contactsService.ERROR, LOG_ID + "(treatPresenceForAllContacts) - id : ", id, " - Catch Error, error : ", error);
});
}
remove(contact) {
let that = this;
let id = (new Date()).getTime();
that.lock(() => {
let currentDate = Date.now();
that._rosterPresenceQueue = that._rosterPresenceQueue.filter(presenceItem => presenceItem.presence.jid!==contact.jid || (presenceItem.date + 10000) < currentDate);
}, id).then(() => {
that._logger.log(that._contactsService.DEBUG, LOG_ID + "(remove) - id : ", id, " - lock succeed.");
}).catch((error) => {
that._logger.log(that._contactsService.ERROR, LOG_ID + "(remove) - id : ", id, " - Catch Error, error : ", error);
});
}
private lockEngine: any;
private lockKey = "LOCK_ROSTER_QUEUE";
}
@logEntryExit(LOG_ID)
@isStarted([])
/**
* @module
* @name ContactsService
* @version SDKVERSION
* @public
* @description
* This module manages _contacts. A contact is defined by a set of public information (name, firstname, avatar...) and a set of private information.
* Using this module, you can get access to your network _contacts or search for Rainbow _contacts.
*
* The main methods proposed in that module allow to:
* - Get the network _contacts (roster)
* - Get and search _contacts by Id, JID or loginEmail
*/
class ContactsService extends GenericService {
private avatarDomain: any;
private _contacts: Array;
public userContact: Contact;
private _rosterPresenceQueue: RosterPresenceQueue;
private _rosterPresenceQueue3: any;
private _invitationsService: InvitationsService;
private _presenceService: PresenceService;
//private _logger: Logger;
static getClassName() { return 'ContactsService'; }
getClassName() { return ContactsService.getClassName(); }
static getAccessorName(){ return 'contacts'; }
getAccessorName(){ return ContactsService.getAccessorName(); }
constructor(_core:Core, _eventEmitter: EventEmitter, _http: any, _logger: Logger, _startConfig: {
start_up:boolean,
optional:boolean
}) {
super(_logger, LOG_ID, _eventEmitter);
this.setLogLevels(this);
this._startConfig = _startConfig;
this.avatarDomain = _http.host.split(".").length===2 ? _http.protocol + "://cdn." + _http.host + ":" + _http.port:_http.protocol + "://" + _http.host + ":" + _http.port;
this._xmpp = null;
this._rest = null;
this._s2s = null;
this._options = {};
this._useXMPP = false;
this._useS2S = false;
this._contacts = [];
this._eventEmitter = _eventEmitter;
this._logger = _logger;
//this._rosterPresenceQueue3 = [];
this._rosterPresenceQueue = new RosterPresenceQueue(_logger, this);
this.userContact = new Contact();
this._core = _core;
this._eventEmitter.on("evt_internal_presencechanged", this._onPresenceChanged.bind(this));
this._eventEmitter.on("evt_internal_onrosterpresence", this._onRosterPresenceChanged.bind(this));
this._eventEmitter.on("evt_internal_onrostercontactinformationchanged", this._onRosterContactInfoChanged.bind(this));
this._eventEmitter.on("evt_internal_oncontactinformationchanged", this._onContactInfoChanged.bind(this));
// this._eventEmitter.on("evt_internal_userinvitemngtreceived", this._onUserInviteReceived.bind(this));
// this._eventEmitter.on("evt_internal_userinviteaccepted", this._onUserInviteAccepted.bind(this));
// this._eventEmitter.on("evt_internal_userinvitecanceled", this._onUserInviteCanceled.bind(this));
this._eventEmitter.on("evt_internal_onrosters", this._onRostersUpdate.bind(this));
this._eventEmitter.on("evt_internal_rainbowcpaasreceived", this._onrainbowcpaasreceived.bind(this));
this._eventEmitter.on("evt_internal_userpasswordconfig", this._onuserpasswordconfig.bind(this));
}
start(_options) { // , _xmpp : XMPPService, _s2s : S2SService, _rest : RESTService, _invitationsService : InvitationsService, _presenceService : PresenceService
let that = this;
that.initStartDate();
return new Promise(function (resolve, reject) {
try {
that._xmpp = that._core._xmpp;
that._rest = that._core._rest;
that._options = _options;
that._s2s = that._core._s2s;
that._useXMPP = that._options.useXMPP;
that._useS2S = that._options.useS2S;
that._invitationsService = that._core.invitations;
that._presenceService = that._core.presence;
that._contacts = [];
// Create the user contact
that._logger.log(that.DEBUG, LOG_ID + "(start) Create userContact (" + that._xmpp.jid + ")");
that.userContact = new Contact();
that.userContact.ask = null;
that.userContact.subscription = null;
// Attach _xmpp information (check)
that.userContact._id = that._xmpp.jid;
that.userContact.jid = that._xmpp.jid;
that.userContact.jidtel = "tel_" + that._xmpp.jid;
that.userContact.jid_im = that._xmpp.jid;
that.userContact.jid_tel = "tel_" + that._xmpp.jid;
//that.userContact.fullJid = that._xmpp.fullJid;
that.setStarted ();
resolve(undefined);
} catch (err) {
that._logger.log(that.ERROR, LOG_ID + "(start) Catch ErrorManager !!!");
that._logger.log(that.INTERNALERROR, LOG_ID + "(start) Catch ErrorManager !!! : ", err.message);
return reject(err);
}
});
}
stop() {
let that = this;
return new Promise(function (resolve, reject) {
try {
that._xmpp = null;
that._rest = null;
that._contacts = [];
that.setStopped ();
resolve(undefined);
} catch (err) {
return reject();
}
});
}
init(useRestAtStartup : boolean) {
return new Promise(async(resolve, reject) => {
let that = this;
if (that._rest.account) {
if (that._rest.account.id) {
let userInfo = that.getContactById(that._rest.account.id, true);
await Promise.all([userInfo]).then((contact: Contact[]) => {
//that._logger.log(that.INTERNAL, LOG_ID + "(init) before updateFromUserData ", contact);
if (contact) {
// Create the contact object
that.userContact.updateFromUserData(contact[0]);
//that.userContact.updateFromUserData(that._rest.account);
that.userContact.avatar = that.getAvatarByContactId(that._rest.account.id, that._rest.account.lastAvatarUpdateDate);
//that.userContact.status = that._presenceService.getUserConnectedPresence().presenceStatus;
//that.userContact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
}
that.setInitialized();
//return resolve(undefined);
}).catch((err) => {
//return resolve(undefined);
//return reject();
that._logger.log(that.ERROR, LOG_ID + "(init) getContactById failed : ", err);
});
return resolve();
}
if (that._rest.account.jid_im) {
let userInfo = await that._rest.getAllUsersByFilter(undefined, undefined,undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined,
undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined,
undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined,
undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined,
undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, that._rest.account.jid_im, undefined)
.then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(init) search by jid_im result : ", result);
that.userContact.updateFromUserData(that._rest.account);
that.userContact.avatar = that.getAvatarByContactId(that._rest.account.id, that._rest.account.lastAvatarUpdateDate);
});
/* .then((contact: Contact) => {
//that._logger.log(that.INTERNAL, LOG_ID + "(init) before updateFromUserData ", contact);
that.userContact.updateFromUserData(contact);
});
// */
await Promise.all([userInfo]).then(() => {
that.setInitialized();
//resolve(undefined);
}).catch((err) => {
that._logger.log(that.WARN, LOG_ID + "(init) search by jid_im failed with error : ", err);
that.setInitialized();
//resolve(undefined);
//return reject();
});
}
} else {
that._logger.log(that.INTERNAL, LOG_ID + "(init) else from contact : ", that._rest.account);
that.setInitialized();
//resolve(undefined);
}
return resolve();
});
}
cleanMemoryCache() {
let that = this;
super.cleanMemoryCache();
for (let i = 0; i < that._contacts.length ; i++) {
if (that._contacts[i]) {
if ( that._contacts[i].isObsoleteCache()) {
that._logger.log(that.INFO, LOG_ID + "(cleanMemoryCache) contact obsolete. Will remove it from cache.");
that._logger.log(that.INTERNAL, LOG_ID + "(cleanMemoryCache) contact obsolete. Will remove it from cache : ", that._contacts[i]);
that._contacts.splice(i,1);
i--;
} else {
that._logger.log(that.INFO, LOG_ID + "(cleanMemoryCache) contact not obsolete.");
that._logger.log(that.INTERNAL, LOG_ID + "(cleanMemoryCache) contact not obsolete : ", that._contacts[i]);
}
} else {
that._logger.log(that.INFO, LOG_ID + "(cleanMemoryCache) contact empty, so it is obsolete. Will remove it from cache.");
that._contacts.splice(i,1);
i--;
}
}
}
//region Contacts MANAGEMENT
createEmptyContactContact(jid : string) {
let that = this;
let contact = that.createBasicContact(jid);
contact.initials = "?";
contact.displayName = "Unknown contact";
contact.lastName = "Unknown contact";
contact.firstName = "";
contact.temp = true;
contact.avatar = {};//new Image();
contact.avatar.src = "/resources/skins/rainbow/images/conversations/unknownContact.png";
return contact;
}
getContact(jid : string, phoneNumber : string) {
let that = this;
let contact: any;
contact = null;
let contactId = jid ? jid:phoneNumber;
if (that.isUserContactJid(contactId)) {
// Create the contact object
contact = new Contact();
// that._logger.log(that.INTERNAL, LOG_ID + "(getContact) before updateFromUserData ", contact);
contact.updateFromUserData(that._rest.account);
contact.status = that._presenceService.getUserConnectedPresence().presenceDetails;
contact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
} else {
contact = that._contacts.find((_contact) => _contact.jid_im===contactId);
}
return contact;
}
getOrCreateContact(jid : string, phoneNumber : string) {
let that = this;
// Reject stupid request
if (!jid && !phoneNumber) {
let error = ErrorManager.getErrorManager().BAD_REQUEST;
error.msg += " No jid or no phoneNumber";
return Promise.reject(error);
}
// Initialize contactsArray if necessary
if (!this._contacts) {
this._contacts = [];
}
// Try to find an existing contact
let contact = this.getContact(jid, phoneNumber);
// If contact found, return resolved promise with contact
if (contact) {
return Promise.resolve(contact);
}
// Else create the contact
contact = that.createBasicContact(jid, phoneNumber);
// Handle case where we have no jid
if (!jid) {
return Promise.resolve(contact);
}
// Fill contact with vCard informations
return that._rest.getContactInformationByJID(jid).then((_contactFromServer: any) => {
let contactIndex = that._contacts.findIndex((value) => {
return value.jid_im===_contactFromServer.jid_im;
});
if (contactIndex!== -1) {
contact = that._contacts[contactIndex];
}
//that._logger.log(that.INTERNAL, LOG_ID + "(getOrCreateContact) before updateFromUserData ", contact);
contact.updateFromUserData(_contactFromServer);
contact.avatar = that.getAvatarByContactId(_contactFromServer.id, _contactFromServer.lastAvatarUpdateDate);
//that._contacts.push(contact);
return Promise.resolve(contact);
});
}
createBasicContact(jid : string, phoneNumber? : string) {
let that = this;
that._logger.log(that.DEBUG, LOG_ID + "[contactService] CreateContact " + jid + " " /* TODO + anonymizePhoneNumber(phoneNumber) */);
// Create the contact object
let contact = new Contact();
// Handle case where we have no jid
if (!jid) {
contact.id = phoneNumber;
contact._id = phoneNumber;
contact.initials = "?";
contact.displayName = phoneNumber ? phoneNumber:"Unknown contact";
contact.lastName = phoneNumber ? phoneNumber:"Unknown contact";
contact.firstName = "";
contact.phoneProCan = phoneNumber ? phoneNumber:"";
contact.temp = true;
contact.loginEmail = "noEmail";
contact.avatar = {}; // new Image();
contact.avatar.src = "/resources/skins/rainbow/images/conversations/unknownContact.png";
contact.setNameUpdatePrio(NameUpdatePrio.NO_UPDATE_PRIO);//not yet updated
return contact;
}
// Compute the contact id
let contactId = jid;
if (!contactId) {
contactId = phoneNumber;
contact.phoneProCan = phoneNumber;
}
if (!contactId) {
contactId = "anonymous";
}
// Configure contact
contact.jid = jid;
contact.jid_im = jid;
contact.jidtel = "tel_" + jid;
contact.id = contactId;
contact._id = jid;
contact.ask = "none";
contact.subscription = "none";
// TODO ? contact.updateRichStatus();
contact.roster = false;
contact.presence = "offline";
contact.status = "";
// Append in contact list
// that._contacts[contact.id] = contact;
that._contacts.push(contact);
return contact;
}
/**
* @private
* @name getContactIdByCriteria
* @param {string|Object} info it can be a string (for a `jid` or an `email`) or a `Contact` to retrieve an id.
* @param {string} typeInfo="jid" if the `info` parameter is a string, it is possible to specify the kind of info. Possible values : "jid"
* @instance
* @description
* this method allows retrieving a contact id
*
* WARNING : this method is not finished ! Issue to make difference between email and jid.
* @returns {Promise}
*
*/
async getContactIdByCriteria(info:any, typeInfo : string = "jid") : Promise {
let that = this;
let id : string="";
if (isObject(info)) {
// it is an object so get id in it
id = info.id;
} else
if (isString(info)) {
//const emailRegex = /[\w.-]+@[\w.-]+\.\w+/; // const info = "Voici mon mail : vincent@test.com";
const strictEmailRegex = /^[\w.-]+@[\w.-]+\.\w+$/; // const info = "vincent@test.com";
if (strictEmailRegex.test(info)) {
//console.log("Email détecté !");
typeInfo = "email";
}
switch (typeInfo) {
case "jid":
case "JID":
id = (await that.getContactByJid(info).catch((err)=>{ that._logger.log(that.ERROR, LOG_ID + "(getContactIdByCriteria) getContactByJid failed : ", err); return undefined;}))?.id;
break;
case "email":
case "EMAIL":
id = await that.getContactIdByLoginEmail(info);
break;
default:
id = info;
break;
}
} else {
id = info;
}
return id;
}
//endregion Contacts MANAGEMENT
//region Contacts INFORMATION
/**
* @public
* @nodered true
* @method getAll
* @category Contacts INFORMATION
* @instance
* @return {Contact[]} the list of _contacts
* @description
* Return the list of _contacts in cache that are in the network of the connected users (aka rosters)
*/
getAll() : Array{
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getAll) .");
return this._contacts?this._contacts.filter(contact => contact.roster):[];
}
/**
* @public
* @nodered true
* @method getAllContactsInCache
* @category Contacts INFORMATION
* @instance
* @return {Contact[]} the list of _contacts
* @description
* Return the list of _contacts that are in the cache of the current instance of the connected users.
* `Note:` the stored contacts can be or not in the network. Rainbow SDK only receives event of contacts in the network.
* So others are only cache about previous exchange, and are cleaned with the clean memory process. The cleaning interval is defined by "intervalBetweenCleanMemoryCache" SDK's option.
*/
getAllContactsInCache() : Array{
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getAllContactsInCache) .");
return this._contacts;
}
/**
* @public
* @nodered true
* @method getContactByJid
* @instance
* @category Contacts INFORMATION
* @param {string} jid The contact jid
* @param {boolean} forceServerSearch=false Boolean to force the search of the _contacts information on the server.
* @description
* Get a contact by his JID by searching in the connected user _contacts list (full information) and if not found by searching on the server too (limited set of information)
* @async
* @return {Promise}
* @fulfil {Contact} - Found contact or null or an error object depending on the result
*/
getContactByJid(jid : string, forceServerSearch : boolean = false): Promise {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactByJid) jid : ", that._logger.stripStringForLogs(jid), ", forceServerSearch : ", forceServerSearch);
return new Promise((resolve, reject) => {
if (!jid) {
that._logger.log(that.WARN, LOG_ID + "(getContactByJid) bad or empty 'jid' parameter", jid);
return reject(ErrorManager.getErrorManager().BAD_REQUEST);
} else {
let contactFound = null;
let connectedUserJid = that._rest.account.jid_im;
if (that._contacts && !forceServerSearch) {
contactFound = that._contacts.find((contact) => {
return contact.jid_im===jid;
});
}
if (contactFound) {
that._logger.log(that.DEBUG, LOG_ID + "(getContactByJid) contact found locally with jid ", jid);
if (contactFound.jid_im===connectedUserJid) {
let connectedUser = that.getConnectedUser() ? that.getConnectedUser():new Contact();
resolve(connectedUser);
} else {
resolve(contactFound);
}
} else {
that._logger.log(that.DEBUG, LOG_ID + "(getContactByJid) contact not found locally. Ask the server...");
return that._rest.getContactInformationByJID(jid).then((_contactFromServer: any) => {
let contact = null;
if (_contactFromServer) {
that._logger.log(that.DEBUG, LOG_ID + "(getContactByJid) contact found on the server.");
//that._logger.log(that.INTERNAL, LOG_ID + "(getContactByJid) contact found on the server : ", _contactFromServer);
let contactIndex = that._contacts.findIndex((value) => {
return value.jid_im===_contactFromServer.jid_im;
});
if (contactIndex!== -1) {
contact = that._contacts[contactIndex];
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByJid) contact found on local _contacts - contact id : ", contact.id, ", contact.displayName : ", contact.displayName, " for contact.jid : ", contact.jid);
} else {
contact = that.createBasicContact(_contactFromServer.jid_im, undefined);
}
//that._logger.log(that.INTERNAL, LOG_ID + "(getContactByJid) before updateFromUserData ", contact);
contact.updateFromUserData(_contactFromServer);
contact.avatar = that.getAvatarByContactId(_contactFromServer.id, _contactFromServer.lastAvatarUpdateDate);
if (contact.jid_im===connectedUserJid) {
contact.status = that._presenceService.getUserConnectedPresence().presenceDetails;
contact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
}
} else {
that._logger.log(that.INFO, LOG_ID + "(getContactByJid) no contact found on the server with Jid", jid);
}
return resolve(contact);
}).catch((err) => {
return reject(err);
});
}
}
});
}
/**
* @public
* @nodered true
* @method getContactById
* @instance
* @category Contacts INFORMATION
* @param {string} id The contact id
* @param {boolean} forceServerSearch=false Boolean to force the search of the _contacts information on the server.
* @description
* Get a contact by his id
* @async
* @return {Promise}
* @fulfil {Contact} - Found contact or null or an error object depending on the result
*/
getContactById(id : string, forceServerSearch: boolean = false): Promise {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactById) id : ", that._logger.stripStringForLogs(id), ", forceServerSearch : ", forceServerSearch);
return new Promise((resolve, reject) => {
if (!id) {
that._logger.log(that.WARN, LOG_ID + "(getContactById) bad or empty 'id' parameter", id);
return reject(ErrorManager.getErrorManager().BAD_REQUEST);
} else {
let contactFound = null;
let connectedUserId = that._rest.account.id;
if (that._contacts && !forceServerSearch) {
contactFound = that._contacts.find((contact) => {
return contact.id===id;
});
}
if (contactFound) {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactById) contact found locally - contactFound id : ", contactFound.id, ", contactFound.displayName : ", contactFound.displayName, " for contact.jid : ", contactFound.jid);
if (contactFound.id===connectedUserId) {
let connectedUser = that.getConnectedUser() ? that.getConnectedUser():new Contact();
return resolve(connectedUser);
} else {
return resolve(contactFound);
}
} else {
that._logger.log(that.DEBUG, LOG_ID + "(getContactById) contact not found locally. Ask the server...");
return that._rest.getContactInformationByID(id).then((_contactFromServer: any) => {
let contact: Contact = null;
if (_contactFromServer) {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactById) contact found on the server : ", _contactFromServer);
that._logger.log(that.INFO, LOG_ID + "(getContactById) contact found on the server");
let contactIndex = that._contacts.findIndex((value) => {
return value.jid_im===_contactFromServer.jid_im;
});
if (contactIndex!== -1) {
//that._logger.log(that.INFO, LOG_ID + "(getContactById) contact found on local _contacts", contact);
that._logger.log(that.INFO, LOG_ID + "(getContactById) contact found on local _contacts");
contact = that._contacts[contactIndex];
} else {
contact = that.createBasicContact(_contactFromServer.jid_im, undefined);
}
//that._logger.log(that.INTERNAL, LOG_ID + "(getContactById) before updateFromUserData ", contact);
contact.updateFromUserData(_contactFromServer);
contact.avatar = that.getAvatarByContactId(_contactFromServer.id, _contactFromServer.lastAvatarUpdateDate);
if (contact.id===connectedUserId) {
contact.status = that._presenceService.getUserConnectedPresence().presenceStatus;
contact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
}
} else {
that._logger.log(that.INFO, LOG_ID + "(getContactById) no contact found on server with id", id);
}
return resolve(contact);
}).catch((err) => {
return reject(err);
});
}
}
});
}
/**
* @public
* @nodered true
* @method getContactByLoginEmail
* @instance
* @category Contacts INFORMATION
* @param {string} loginEmail The contact loginEmail
* @param {boolean} forceServerSearch=false Boolean to force the search of the _contacts information on the server.
* @description
* Get a contact by his loginEmail
* @async
* @return {Promise}
* @fulfil {Contact} - Found contact or null or an error object depending on the result
*
*/
async getContactByLoginEmail(loginEmail : string, forceServerSearch: boolean = false): Promise {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactByLoginEmail) loginEmail : ", that._logger.stripStringForLogs(loginEmail), ", forceServerSearch : ", forceServerSearch);
return new Promise((resolve, reject) => {
if (!loginEmail) {
that._logger.log(that.WARN, LOG_ID + "(getContactByLoginEmail) bad or empty 'loginEmail' parameter");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getContactByLoginEmail) bad or empty 'loginEmail' parameter : ", loginEmail);
return reject(ErrorManager.getErrorManager().BAD_REQUEST);
} else {
let contactFound: Contact = null;
let connectedUser = that.getConnectedUser() ? that.getConnectedUser():new Contact();
if (that._contacts && !forceServerSearch) {
contactFound = that._contacts.find((contact) => {
return contact.loginEmail===loginEmail;
});
}
if (contactFound) {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) contact found locally - contactFound id : ", contactFound.id, ", contactFound.displayName : ", contactFound.displayName, " for contact.jid : ", contactFound.jid);
if (contactFound.id===connectedUser.id) {
resolve(connectedUser);
} else {
resolve(contactFound);
}
} else {
that._logger.log(that.DEBUG, LOG_ID + "(getContactByLoginEmail) contact not found locally. Ask server...");
that._rest.getContactInformationByLoginEmail(loginEmail).then(async (contactsFromServeur: [any]) => {
if (contactsFromServeur && contactsFromServeur.length > 0) {
let contact: Contact = null;
that._logger.log(that.INFO, LOG_ID + "(getContactByLoginEmail) contact found on server");
let _contactFromServer = contactsFromServeur[0];
if (_contactFromServer) {
// The contact is not found by email in the that._contacts tab, so it need to be find on server to get or update it.
await that.getContactById(_contactFromServer.id, true).then((contactInformation: Contact) => {
contact = contactInformation;
// Workaround because server does not return the email when not in same company, even if it has been found by email on server.
if (!contact.loginEmail) {
contact.loginEmail = loginEmail;
}
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) full data contact - contact id : ", contact.id, ", contact.displayName : ", contact.displayName, " for contact.jid : ", contact.jid, ", found on server with loginEmail : ", loginEmail);
/*let contactIndex = that._contacts.findIndex((value) => {
return value.jid_im === contactInformation.jid_im;
});
if (contactIndex !== -1) {
contact = that._contacts[contactIndex];
} else {
contact = that.createBasicContact(contactInformation.jid_im, undefined);
}
//that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) before updateFromUserData ", contact);
contact.updateFromUserData(contactInformation);
contact.avatar = that.getAvatarByContactId(contactInformation.id, contactInformation.lastAvatarUpdateDate);
*/
if (contact.loginEmail===connectedUser.loginEmail) {
contact.status = that._presenceService.getUserConnectedPresence().presenceStatus;
contact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
}
}).catch((err)=>{ that._logger.log(that.ERROR, LOG_ID + "(getContactByLoginEmail) getContactById failed : ", err); return undefined;});
} else {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) no contact found on server with loginEmail : ", loginEmail);
}
resolve(contact);
} else {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) contact not found on server with loginEmail : ", loginEmail);
resolve(null);
}
}).catch((err) => {
return reject(err);
});
}
}
});
}
/**
* @public
* @nodered true
* @method getContactIdByLoginEmail
* @instance
* @category Contacts INFORMATION
* @param {string} loginEmail The contact loginEmail
* @param {boolean} forceServerSearch=false Boolean to force the search of the _contacts information on the server.
* @description
* Get a contact Id by his loginEmail
* @async
* @return {Promise}
* @fulfil {string} - Found contact Id or null or an error object depending on the result
*/
async getContactIdByLoginEmail(loginEmail : string, forceServerSearch: boolean = false): Promise {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactIdByLoginEmail) loginEmail : ", that._logger.stripStringForLogs(loginEmail), ", forceServerSearch : ", forceServerSearch);
return new Promise((resolve, reject) => {
if (!loginEmail) {
that._logger.log(that.WARN, LOG_ID + "(getContactByLoginEmail) bad or empty 'loginEmail' parameter");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getContactByLoginEmail) bad or empty 'loginEmail' parameter : ", loginEmail);
return reject(ErrorManager.getErrorManager().BAD_REQUEST);
} else {
let contactFound: Contact = null;
let connectedUser = that.getConnectedUser() ? that.getConnectedUser():new Contact();
if (that._contacts && !forceServerSearch) {
contactFound = that._contacts.find((contact) => {
return contact.loginEmail===loginEmail;
});
}
if (contactFound) {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) contact found locally - contactFound id : ", contactFound.id, ", contactFound.displayName : ", contactFound.displayName, " for contact.jid : ", contactFound.jid);
resolve(contactFound.id);
} else {
that._logger.log(that.DEBUG, LOG_ID + "(getContactByLoginEmail) contact not found locally. Ask server...");
that._rest.getContactInformationByLoginEmail(loginEmail).then(async (contactsFromServeur: [any]) => {
let contactId: string = undefined;
if (contactsFromServeur && contactsFromServeur.length > 0) {
//let contact: Contact = null;
that._logger.log(that.INFO, LOG_ID + "(getContactByLoginEmail) contact found on server");
let _contactFromServer = contactsFromServeur[0];
if (_contactFromServer) {
contactId = _contactFromServer.id;
} else {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) no contact found on server with loginEmail : ", loginEmail);
}
} else {
that._logger.log(that.INTERNAL, LOG_ID + "(getContactByLoginEmail) contact not found on server with loginEmail : ", loginEmail);
}
resolve(contactId);
}).catch((err) => {
return reject(err);
});
}
}
});
}
/**
* @public
* @nodered true
* @method getMyInformations
* @instance
* @category Contacts INFORMATION
* @description
* Get information about the connected user
* @async
* @return {Promise}
* @fulfil {Object} - Found information or null or an error object depending on the result
*/
getMyInformations(): Promise {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactByJid) .");
return new Promise((resolve, reject) => {
that._logger.log(that.DEBUG, LOG_ID + "(getMyInformations) Ask the server...");
that._rest.getMyInformations().then((_contactFromServer: any) => {
that._logger.log(that.INTERNAL, LOG_ID + "(getMyInformations) contact informations found on server : ", _contactFromServer);
resolve(_contactFromServer);
}).catch((err) => {
return reject(err);
});
});
}
/**
* @public
* @nodered true
* @method getPeerById
* @instance
* @param {string} peerId ID of another user, ID of a room or ID of a bot, according to value of type field:
* user ID: id returned in Contact objects. user ID is also available in user vCard via a proprietary field name 'rainbowId'.
* room ID: id returned in Bubble objects.
* @category Contacts INFORMATION
* @description
* Get information about a peer by id. Can be a "user", a "room"
* @async
* @return {Promise}
* @fulfil {Object} - Found information or null or an error object depending on the result
*/
public async getPeerById(peerId : string): Promise {
let resultPeer: {peer : any, type: PEERTYPE } = {peer:null, type:PEERTYPE.UNKNOWN};
let that = this;
try {
if (this.userContact.id===peerId) {
resultPeer.peer = this.userContact;
resultPeer.type = PEERTYPE.USER;
} else {
const contact = await that.getContactById(peerId).catch((err)=>{ that._logger.log(that.ERROR, LOG_ID + "(getPeerById) getContactById failed : ", err); return undefined;});
if (! contact) {
const bubble = await that._core._bubbles.getBubbleById(peerId);
if (! bubble) {
} else {
resultPeer.peer = bubble;
resultPeer.type = PEERTYPE.ROOM;
}
} else {
resultPeer.peer = contact;
resultPeer.type = PEERTYPE.USER;
}
}
return resultPeer;
} catch (error) {
}
}
/**
* @public
* @nodered true
* @method getPeerByJid
* @instance
* @param {string} peerJid JID of another user, JID of a room or JID of a bot, according to value of type field:
* user JID: id returned in Contact objects.
* room JID: id returned in Bubble objects.
* @category Contacts INFORMATION
* @description
* Get information about a peer by jid. Can be a "user", a "room"
* @async
* @return {Promise}
* @fulfil {Object} - Found information or null or an error object depending on the result
*/
public async getPeerByJid(peerJid : string): Promise<{peer : any, type: PEERTYPE }> {
let resultPeer: {peer : any, type: PEERTYPE } = {peer:null, type:PEERTYPE.UNKNOWN};
let that = this;
try {
if (this.userContact.jid===peerJid || this.userContact.jid_im===peerJid) {
resultPeer.peer = this.userContact;
resultPeer.type = PEERTYPE.USER;
} else {
const contact = await that.getContactByJid(peerJid).catch((err)=>{ that._logger.log(that.ERROR, LOG_ID + "(getPeerByJid) getContactByJid failed : ", err); return undefined;});
if (! contact) {
const bubble = await that._core._bubbles.getBubbleByJid(peerJid);
if (! bubble) {
} else {
resultPeer.peer = bubble;
resultPeer.type = PEERTYPE.ROOM;
}
} else {
resultPeer.peer = contact;
resultPeer.type = PEERTYPE.USER;
}
}
return resultPeer;
} catch (error) {
}
}
/**
* @public
* @nodered true
* @method getContactsInformationByIds
* @instance
* @category Contacts INFORMATION
* @param {Array} iDs Allows to search users having id equal to one of the ids provided in this option.
* @param {string} sortOrder=1 Users are sorted by id. sortOrder allows to specify order when sorting user list. Default value : 1. Possible values : -1, 1.
* @param {boolean} forceServerSearch=false Boolean to force the search of the _contacts information on the server.
* @description
* Get a list of _contacts details by IDs.
* @async
* @return {Promise,ErrorManager>}
* @fulfil {ErrorManager} - ErrorManager object depending on the result (ErrorManager.getErrorManager().OK in case of success)
*/
getContactsInformationByIds(iDs : Array, sortOrder: number = 1, forceServerSearch : boolean = false) : Promise> {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactsInformationByIds) .");
return new Promise((resolve, reject) => {
if (!iDs) {
that._logger.log(that.WARN, LOG_ID + "(getContactsInformationByIds) bad or empty 'iDs' parameter.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getContactsInformationByIds) bad or empty 'iDs' parameter : ", iDs);
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
let result = [];
let id_im_server = [];
if (!forceServerSearch) {
for (const id of iDs) {
that._logger.log(that.INFO, LOG_ID + "(getContactsInformationByIds) id : ", id);
let contactFound: any = false;
if (that._contacts) {
contactFound = that._contacts.find((contact) => {
return contact.id===id;
});
}
if (contactFound) {
that._logger.log(that.DEBUG, LOG_ID + "(getContactsInformationByIds) contact found locally with id ", id);
result.push(contactFound);
} else {
id_im_server.push(id);
}
}
} else {
id_im_server = iDs;
}
if (id_im_server && id_im_server.length > 0) {
that._rest.getContactsInformationByJIDs(id_im_server, sortOrder).then(async (listOfContacts: any) => {
for (const aContact of listOfContacts) {
that._logger.log(that.INFO, LOG_ID + "(getContactsInformationByIds) contact : ", aContact);
// Update or Add contact
let contactIndex = that._contacts.findIndex((_contact: any) => {
return _contact.id_im===aContact.id_im;
});
let contact = null;
//that._logger.log(that.INTERNAL, LOG_ID + "(_onRosterContactInfoChanged) contact found on the server : ", contact);
if (contactIndex!== -1) {
contact = that._contacts[contactIndex];
//that._logger.log(that.INTERNAL, LOG_ID + "(_onRosterContactInfoChanged) local contact before updateFromUserData ", contact);
contact.updateFromUserData(aContact);
contact.avatar = that.getAvatarByContactId(aContact.id, aContact.lastAvatarUpdateDate);
} else {
contact = that.createBasicContact(aContact.id_im, undefined);
//that._logger.log(that.INTERNAL, LOG_ID + "(_onRosterContactInfoChanged) from server contact before updateFromUserData ", contact);
contact.updateFromUserData(aContact);
contact.roster = true;
contact.avatar = that.getAvatarByContactId(aContact.id, aContact.lastAvatarUpdateDate);
}
result.push(contact);
}
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(getContactsInformationByIds) error");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getContactsInformationByIds) error : ", err);
return reject(err);
});
} else {
resolve(result);
}
});
}
/**
* @public
* @nodered true
* @method getContactsInformationByJIDs
* @instance
* @category Contacts INFORMATION
* @param {Array} JIDs Allows to search users having jid_im equal to one of the jids provided in this option.
* @param {string} sortOrder=1 Users are sorted by jid_im. sortOrder allows to specify order when sorting user list. Default value : 1. Possible values : -1, 1.
* @param {boolean} forceServerSearch=false Boolean to force the search of the _contacts information on the server.
* @description
* Get a list of _contacts details by JIDs.
* @async
* @return {Promise,ErrorManager>}
* @fulfil {ErrorManager} - ErrorManager object depending on the result (ErrorManager.getErrorManager().OK in case of success)
*/
getContactsInformationByJIDs(JIDs : Array, sortOrder: number = 1, forceServerSearch : boolean = false) : Promise> {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getContactsInformationByJIDs) .");
return new Promise((resolve, reject) => {
if (!JIDs) {
that._logger.log(that.WARN, LOG_ID + "(getContactsInformationByJIDs) bad or empty 'JIDs' parameter.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getContactsInformationByJIDs) bad or empty 'JIDs' parameter : ", JIDs);
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
let result = [];
let JIDs_server = [];
if (!forceServerSearch) {
for (const jid of JIDs) {
that._logger.log(that.INFO, LOG_ID + "(getContactsInformationByJIDs) jid : ", jid);
let contactFound: any = false;
if (that._contacts) {
contactFound = that._contacts.find((contact) => {
return contact.jid_im===jid;
});
}
if (contactFound) {
that._logger.log(that.DEBUG, LOG_ID + "(getContactsInformationByJIDs) contact found locally with jid ", jid);
result.push(contactFound);
} else {
JIDs_server.push(jid);
}
}
} else {
JIDs_server = JIDs;
}
if (JIDs_server && JIDs_server.length > 0) {
that._rest.getContactsInformationByJIDs(JIDs_server, sortOrder).then(async (listOfContacts: any) => {
for (const aContact of listOfContacts) {
that._logger.log(that.INFO, LOG_ID + "(getContactsInformationByJIDs) contact : ", aContact);
// Update or Add contact
let contactIndex = that._contacts.findIndex((_contact: any) => {
return _contact.jid_im===aContact.jid_im;
});
let contact = null;
//that._logger.log(that.INTERNAL, LOG_ID + "(_onRosterContactInfoChanged) contact found on the server : ", contact);
if (contactIndex!== -1) {
contact = that._contacts[contactIndex];
//that._logger.log(that.INTERNAL, LOG_ID + "(_onRosterContactInfoChanged) local contact before updateFromUserData ", contact);
contact.updateFromUserData(aContact);
contact.avatar = that.getAvatarByContactId(aContact.id, aContact.lastAvatarUpdateDate);
} else {
contact = that.createBasicContact(aContact.jid_im, undefined);
//that._logger.log(that.INTERNAL, LOG_ID + "(_onRosterContactInfoChanged) from server contact before updateFromUserData ", contact);
contact.updateFromUserData(aContact);
contact.roster = true;
contact.avatar = that.getAvatarByContactId(aContact.id, aContact.lastAvatarUpdateDate);
}
result.push(contact);
}
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(getContactsInformationByJIDs) error");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getContactsInformationByJIDs) error : ", err);
return reject(err);
});
} else {
resolve(result);
}
});
}
/**
* @public
* @nodered true
* @method getCompanyInfos
* @instance
* @category Contacts INFORMATION
* @param {string} companyId The company id unique identifier
* @param {string} format="small" Allows to retrieve more or less company details in response.
* * small: id, name
* * medium: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape
* * full: id, name, status, adminEmail, companyContactId, country, website, slogan, description, size, economicActivityClassification, lastAvatarUpdateDate, lastBannerUpdateDate, avatarShape
* When a user wants data of his own company in 'full' mode, he gets all fields except subscriptions and fields related to a business partner managing this company.
* Default value : full. Possibles values : small, medium, full
* @param {boolean} selectedThemeObj Allows to return selectedTheme attribute as an object:
* * true returns selectedTheme as an object (e.g. { "light": "60104754c8fada2ad4be3e48", "dark": "5ea304e4359c0e6815fc8b57" }),
* * false return selectedTheme as a string.
* @param {string} name Allows to filter companies list on the given keyword(s) on field name.
* The filtering is case insensitive and on partial name match: all companies containing the provided name value will be returned (whatever the position of the match).
* Ex: if filtering is done on comp, companies with the following names are match the filter 'My company', 'Company', 'A comp 1', 'Comp of comps', ...
* @param {string} status Allows to filter companies list on the provided status(es). Possibles values initializing, active, alerting, hold, terminated
* @param {string} visibility Allows to filter companies list on the provided visibility(ies). Possibles values public, private, organization, closed, isolated
* @param {string} organisationId Allows to filter companies list on the organisationIds provided in this option. This filter can only be used if user has role(s) superadmin, support, bp_admin or admin
* @param {boolean} isBP Allows to filter companies list on isBP field:
* * true returns only Business Partner companies,
* * false return only companies which are not Business Partner.
* This filter can only be used if user has role(s) superadmin, business_admin,customer_success_admin, support, bp_admin or admin.
* @param {boolean} hasBP Allows to filter companies list on companies being linked or not to a BP:
* * true returns only companies linked to a BP (BP IR companies are also returned),
* * false return only companies which are not linked to a BP.
* This filter can only be used if user has role(s) superadmin, business_admin,customer_success_admin, support or bp_admin.
* Users with role bp_admin can only use this filter with value false.
* @param {string} bpType Allows to filter companies list on bpType field.
* This filter allow to get all the Business Partner companies from a given bpType.
* Only users with role superadmin, business_admin,customer_success_admin, support or bp_admin can use this filter.
* @description
* This API allows user to get a company data.
* **Users can only retrieve their own company and companies they can see** (companies with `visibility`=`public`, companies having user's companyId in `visibleBy` field, companies being in user's company organization and having `visibility`=`organization`, BP company of user's company).
* If user request his own company, `numberUsers` field is returned with the number of Rainbow users being in this company.
* @return {string} Contact avatar URL or file
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | numberUsers | Number | Number of Rainbow users being associated to the company. Only returned if the requested company is the logged in user's company. |
* | meetingRecordingCustomisation | String | Activate/Deactivate the capability for a user to record a meeting. Defines if a user can record a meeting. meetingRecordingCustomisation can be:
* `enabled`: The user can record a meeting. * `disabled`: The user can't record a meeting. |
* | eLearningGamificationCustomisation | String | Activate/Deactivate the capability for a user to earn badges for Elearning progress. Defines if a user can earn badges for Elearning progress. eLearningGamificationCustomisation can be:
* `enabled`: The user can earn badges for Elearning progress. * `disabled`: The user can't earn badges for Elearning progress. |
* | eLearningCustomisation | String | Activate/Deactivate the capability for a user to participate on a Elearning training. Defines if a user can particapate on an Elearning training. eLearningCustomisation can be:
* `enabled`: The user can participate on an Elearning training. * `disabled`: The user can't participate on an Elearning training. |
* | autoAcceptUserInvitations optionnel | Boolean | Allow to enable or disable the auto-acceptation of user invitations between users of this company (default true: enabled)
Default value : `true` |
* | dataLocation | Object | Information regarding the location where the company data and relative private data are stored (including users of the company and their own private data). Only returned if the requested company is the logged in user's company. |
* | name | String | Name of the zone where the company data are stored. |
* | location | String | Location of the zone where the company data are stored. Should usually be the country name (English) where the zone is located. |
* | country | String | Country (ISO 3166-1 alpha3 format) of the zone where the company data are stored |
* | id | String | Company unique identifier |
* | creationDate | Date-Time | Company creation date (Read only) |
* | statusUpdatedDate | Date-Time | Date of last company status update (Read only) |
* | lastAvatarUpdateDate | Date-Time | Date of last company avatar update (Read only) |
* | name | String | Company name |
* | country optionnel | String | Company country (ISO 3166-1 alpha3 format)
The list of allowed countries can be obtained using the API [GET /api/rainbow/enduser/v1.0/countries](/enduser/#api-countries-getCountries) |
* | street optionnel | String | Company street |
* | city optionnel | String | Company city |
* | state optionnel | String | When country is 'USA' or 'CAN', a state must be defined. Else it is not managed.
The list of allowed states can be obtained using the API [GET /api/rainbow/enduser/v1.0/countries](/enduser/#api-countries-getCountries) for the associated countries.
Possibles values `USD`, `EUR`, `CNY` |
* | status | String | Company status
Possibles values `initializing`, `active`, `alerting`, `hold`, `terminated` |
* | visibility optionnel | string | Company visibility (define if users being in this company can be searched by users being in other companies and if the user can search users being in other companies).
* `public`: User can be searched by external users / can search external users. User can invite external users / can be invited by external users * `private`: User **can't** be searched by external users (even within his organisation) / can search external users. User can invite external users / can be invited by external users * `organisation`: User **can't** be searched by external users / can search external users. User can invite external users / can be invited by external users * `closed`: User **can't** be searched by external users / **can't** search external users. User can invite external users / can be invited by external users * `isolated`: User **can't** be searched by external users / **can't** search external users. User **can't** invite external users / **can't** be invited by external users * `none`: Default value reserved for guest. User **can't** be searched by **any users** (even within the same company) / can search external users. User can invite external users / can be invited by external users
External users mean public user not being in user's company nor user's organisation nor a company visible by user's company.
Note related to organisation visibility:
* Under the same organisation, a company can choose the visibility=organisation. That means users belonging to this company are visible for users of foreign companies inside the same organisation. * The visibility=organisation is same as visibility=private outside the organisation. That is to say users can't be searched outside the organisation's companies.
Default value : `private`
Possibles values `public`, `private`, `organisation`, `closed`, `isolated` |
* | visibleBy | String\[\] | If visibility is private, list of companyIds for which visibility is allowed |
* | adminEmail optionnel | String | Company contact person email |
* | supportEmail optionnel | String | Company support email |
* | supportUrlFAQ optionnel | String | Company support URL |
* | companyContactId optionnel | String | User Id of a Rainbow user which is the contact for this company |
* | disableCCareAdminAccess optionnel | Boolean | When True, disables the access to the customer care logs for admins of this company. Note that if `disableCCareAdminAccessCustomers` is enabled on its BP company or `disableCCareAdminAccessResellers` is enabled on its BP VAD company, this setting is forced to true. |
* | disableCCareAdminAccessCustomers optionnel | Boolean | When True, disables the access to the customer care logs for admins of all the customers company. This setting is only applicable for BP companies (`isBP`=true)
* If the BP company is a DR or an IR, enabling this setting disables the access to the customer care logs for the admins of all its customers companies. * If the BP company is a VAD, enabling this setting disables the access to the customer care logs for all the admins of its customers companies. Note that the bp_admins/admins of all the BP IRs companies linked to this VAD still have access to the customer care logs (the setting `disableCCareAdminAccessResellers` on the BP VAD company allows to disable it). |
* | disableCCareAdminAccessResellers optionnel | Boolean | When True, disables the access to the customer care logs for admins of all the BP IRs companies linked to the BP VAD and their customers company. This setting is only applicable for BP VAD companies (`isBP`=true and `bpType`=`VAD`) Enabling this setting disables on the BP VAD company disables the access to the customer care logs for the bp_admins/admins of all the BP IRs linked to this VAD, and to all the admins of their customers. Note that the admins of all the customer companies directly linked to this VAD still have access to the customer care logs (the setting `disableCCareAdminAccessCustomers` on the BP VAD company allows to disable it). |
* | userSelfRegisterEnabled | Boolean | Allow users with email domain matching 'userSelfRegisterAllowedDomains' to join the company by self-register process |
* | userSelfRegisterAllowedDomains | String\[\] | Allow users with email domain matching one of the values of this array to join the company by self-register process (if userSelfRegisterEnabled is true) |
* | slogan optionnel | String | A free string corresponding to the slogan of the company (255 char length) |
* | description optionnel | String | A free string that describes the company (2000 char length) |
* | size | String | An overview of the number of employees
Possibles values `"self-employed"`, `"1-10 employees"`, `"11-50 employees"`, `"51-200 employees"`, `"201-500 employees"`, `"501-1000 employees"`, `"1001-5000 employees"`, `"5001-10,000 employees"`, `"10,001+ employees"` |
* | economicActivityClassification optionnel | String | * `A`: AGRICULTURE, FORESTRY AND FISHING * `B`: MINING AND QUARRYING * `C`: MANUFACTURING * `D`: ELECTRICITY, GAS, STEAM AND AIR CONDITIONING SUPPLY * `E`: WATER SUPPLY; SEWERAGE, WASTE MANAGEMENT AND REMEDIATION ACTIVITIES * `F`: CONSTRUCTION * `G`: WHOLESALE AND RETAIL TRADE; REPAIR OF MOTOR VEHICLES AND MOTORCYCLES * `H`: TRANSPORTATION AND STORAGE * `I`: ACCOMMODATION AND FOOD SERVICE ACTIVITIES * `J`: INFORMATION AND COMMUNICATION * `K`: FINANCIAL AND INSURANCE ACTIVITIES * `L`: REAL ESTATE ACTIVITIES * `M`: PROFESSIONAL, SCIENTIFIC AND TECHNICAL ACTIVITIES * `N`: ADMINISTRATIVE AND SUPPORT SERVICE ACTIVITIES * `O`: PUBLIC ADMINISTRATION AND DEFENCE; COMPULSORY SOCIAL SECURITY * `P`: EDUCATION * `Q`: HUMAN HEALTH AND SOCIAL WORK ACTIVITIES * `R`: ARTS, ENTERTAINMENT AND RECREATION * `S`: OTHER SERVICE ACTIVITIES * `T`: ACTIVITIES OF HOUSEHOLDS AS EMPLOYERS; UNDIFFERENTIATED GOODS- AND SERVICES-PRODUCING ACTIVITIES OF HOUSEHOLDS FOR OWN USE * `U`: ACTIVITIES OF EXTRATERRITORIAL ORGANISATIONS AND BODIES
Possibles values `"NONE"`, `"A"`, `"B"`, `"C"`, `"D"`, `"E"`, `"F"`, `"G"`, `"H"`, `"I"`, `"J"`, `"K"`, `"L"`, `"M"`, `"N"`, `"O"`, `"P"`, `"Q"`, `"R"`, `"S"`, `"T"`, `"U"` |
* | giphyEnabled optionnel | Boolean | Whether or not giphy feature is enabled for users belonging to this company (possibility to use animated gifs in conversations) |
* | website optionnel | String | Company website URL |
* | organisationId | String | Optional identifier to indicate the company belongs to an organisation |
* | catalogId | String | Id of the catalog of Rainbow offers to which the company is linked. The catalog corresponds to the list of offers the company can subscribe. |
* | bpId | String | Optional identifier which links the company to the corresponding Business partner company |
* | adminHasRightToUpdateSubscriptions optionnel | Boolean | In the case the company is linked to a Business Partner company, indicates if the `bp_admin` allows the `company_admin` to update the subscriptions of his company (if enable, allowed operations depend of the value of `adminAllowedUpdateSubscriptionsOps`). Can only be set by `superadmin` or `bp_admin`/`bp_finance` of the related company. |
* | adminAllowedUpdateSubscriptionsOps optionnel | String | In the case the company is linked to a Business Partner company and `adminHasRightToUpdateSubscriptions` is enabled, indicates the update operations for which the `bp_admin` allows the `company_admin` to perform on the subscriptions of his company.
Can only be set by `superadmin` or `bp_admin`/`bp_finance` of the related company.
Possible values:
* `all`: company_admin is allowed to perform all update operations on the subscriptions of his company * `increase_only`: company_admin is only allowed to increase `maxNumberUsers` on the subscriptions of his company (decrease is forbidden)
Possibles values `all`, `increase_only` |
* | isBP | Boolean | Indicates if the company is a Business partner company
Default value : `false` |
* | bpType optionnel | String | Indicates BP Company type
* `IR`: Indirect Reseller, * `VAD`: Value Added Distributor, * `DR`: Direct Reseller.
Possibles values `IR`, `VAD`, `DR` |
* | bpBusinessModel optionnel | String | Indicates BP business model |
* | bpApplicantNumber optionnel | String | Reference of the Business Partner in ALE Finance tools (SAP) |
* | bpCRDid optionnel | String | Reference of the Business Partner in CDR |
* | bpHasRightToSell optionnel | Boolean | Indicates if the Business has the right to sell |
* | bpHasRightToConnect optionnel | Boolean | When True, the BP can connect CPE equipment of managed companies. So when False, the "equipment" tab should be removed from the admin GUI |
* | bpIsContractAccepted optionnel | Boolean | Indicates if the Business has accepted the contract and can sell Rainbow offers |
* | bpContractAcceptationInfo optionnel | Object | If the Business has accepted the contract, indicates who accepted the contract, Only visible by `superadmin` and `support`. |
* | acceptationDate | Date-Time | Date of contract acceptation by the BP admin |
* | bpAdminId | String | User Id of the BP admin who accepted the contract |
* | offerType | String | Allowed company offer types
Possibles values `freemium`, `premium` |
* | bpAdminLoginEmail | String | User loginEmail of the BP admin who accepted the contract |
* | businessSpecific optionnel | String | When the customer has subscribed to specific business offers, this field is set to the associated specific business (ex: HDS for HealthCare business specific)
Possibles values `HDS` |
* | externalReference optionnel | String | Free field that BP can use to link their customers to their IS/IT tools Only applicable by `superadmin` or by `bp_admin`/`bp_finance` on one of his customer companies. |
* | externalReference2 optionnel | String | Free field that BP can use to link their customers to their IS/IT tools Only applicable by `superadmin` or by `bp_admin`/`bp_finance` on one of his customer companies. |
* | avatarShape optionnel | String | Company's avatar customization
Possibles values `square`, `circle` |
* | allowUsersSelectTheme | Boolean | Allow users of this company to select a theme among the ones available (owned or visible by the company). |
* | allowUsersSelectPublicTheme | Boolean | Allow users of this company to select a public theme. |
* | selectedTheme optionnel | Object | Set the selected theme(s) for users of the company. |
* | light optionnel | String | Set the selected theme light for users of the company. |
* | dark optionnel | String | Set the selected theme dark for users of the company. |
* | adminCanSetCustomData optionnel | Boolean | Whether or not administrators can set `customData` field for their own company. |
* | isLockedByBp optionnel | Boolean | Whether or not BP company has locked themes so that indicates if company admin can manage themes (create/update/delete). |
* | superadminComment optionnel | String | Free field that only `superadmin` can see |
* | bpBusinessType optionnel | String\[\] | Business type that can be sold by a BP.
Possibles values `voice_by_partner`, `voice_by_ale`, `conference`, `default` |
* | billingModel optionnel | String | Billing model that can be subscribed for this company.
Possibles values `monthly`, `prepaid_1y`, `prepaid_3y`, `prepaid_5y` |
* | office365Tenant optionnel | String | Office365 tenant configured for this company. |
* | office365ScopesGranted optionnel | String\[\] | Scopes granted to Rainbow for usage of Microsoft Office365 APIs. If no office365Tenant is set or if admin has not granted access of Office365 APIs to Rainbow for the configured office365Tenant, office365ScopesGranted is set to an empty Array. Otherwise, office365ScopesGranted lists the scopes requested by Rainbow to use Office365 APIs for the configured office365Tenant. This field can be used to determine if the admin must re-authenticate to Microsoft Office365 in the case new scopes are requested for Rainbow application (scopes requested for the current version of office365-portal are listed in API GET /api/rainbow/office365/v1.0/consent).
Possibles values `directory`, `calendar` |
* | mobilePermanentConnectionMode | Boolean | deactivate push mode for mobile devices. When we can't rely on Internet and Google FCM services to wake-up the app or notify the app, we can fall back to a direct XMPP connection. For customers using Samsung devices with Google Play services, we must have an option on admin side to set this permanent connection mode, so that mobile apps can rely on this parameter. This option will be applied for the whole company. |
* | fileSharingCustomisation | String | Activate/Deactivate file sharing capability per company Define if the company can use the file sharing service then, allowed to download and share file. FileSharingCustomisation can be:
* `enabled`: Each user of the company can use the file sharing service, except when his own capability is set to 'disabled'. * `disabled`: No user of the company can use the file sharing service, except when his own capability is set to 'enabled'. When one user of the company has the capability 'fileSharingCustomisation' set to 'same\_than\_company', his capability follow the company setting. |
* | userTitleNameCustomisation | String | Activate/Deactivate the capability for a user to modify his profile (title, firstName, lastName) per company Define if the company allows his users to change some profile data. userTitleNameCustomisation can be:
* `enabled`: Each user of the company can change some profile data, except when his own capability is set to 'disabled'. * `disabled`: No user of the company can change some profile data, except when his own capability is set to 'enabled'. When one user of the company has the capability 'userTitleNameCustomisation' set to 'same\_than\_company', his capability follow the company setting. |
* | softphoneOnlyCustomisation | String | Activate/Deactivate the capability for an UCaas application not to offer all Rainbow services and but to focus to telephony services. Define if UCaas apps used by a user of this company must provide Softphone functions, i.e. no chat, no bubbles, no meetings, no channels, and so on. softphoneOnlyCustomisation can be:
* `enabled`: The user switch to a softphone mode only. * `disabled`: The user can use telephony services, chat, bubbles, channels meeting services and so on. |
* | useRoomCustomisation | String | Activate/Deactivate the capability for a user to use bubbles. Define if a user can create bubbles or participate in bubbles (chat and web conference). useRoomCustomisation can be:
* `enabled`: Each user of the company can use bubbles. * `disabled`: No user of the company can use bubbles. |
* | phoneMeetingCustomisation | String | Activate/Deactivate the capability for a user to use phone meetings (PSTN conference). Define if a user has the right to join phone meetings. phoneMeetingCustomisation can be:
* `enabled`: Each user of the company can join phone meetings. * `disabled`: No user of the company can join phone meetings. |
* | useChannelCustomisation | String | Activate/Deactivate the capability for a user to use a channel. Define if a user has the right to create channels or be a member of channels. useChannelCustomisation can be:
* `enabled`: Each user of the company can use some channels. * `disabled`: No user of the company can use some channel. |
* | useScreenSharingCustomisation | String | Activate/Deactivate the capability for a user to share a screen. Define if a user has the right to share his screen. useScreenSharingCustomisation can be:
* `enabled`: Each user of the company can share his screen. * `disabled`: No user of the company can share his screen. |
* | useWebRTCVideoCustomisation | String | Activate/Deactivate the capability for a user to switch to a Web RTC video conversation. Define if a user has the right to be joined via video and to use video (start a P2P video call, add video in a P2P call, add video in a web conference call). useWebRTCVideoCustomisation can be:
* `enabled`: Each user of the company can switch to a Web RTC video conversation. * `disabled`: No user of the company can switch to a Web RTC video conversation. |
* | useWebRTCAudioCustomisation | String | Activate/Deactivate the capability for a user to switch to a Web RTC audio conversation. Define if a user has the right to be joined via audio (WebRTC) and to use Rainbow audio (WebRTC) (start a P2P audio call, start a web conference call). useWebRTCVideoCustomisation can be:
* `enabled`: Each user of the company can switch to a Web RTC audio conversation. * `disabled`: No user of the company can switch to a Web RTC audio conversation. |
* | instantMessagesCustomisation | String | Activate/Deactivate the capability for a user to use instant messages. Define if a user has the right to use IM, then to start a chat (P2P ou group chat) or receive chat messages and chat notifications. instantMessagesCustomisation can be:
* `enabled`: Each user of the company can use instant messages. * `disabled`: No user of the company can use instant messages. |
* | userProfileCustomisation | String | Activate/Deactivate the capability for a user to modify his profile. Define if a user has the right to modify the globality of his profile and not only (title, firstName, lastName). userProfileCustomisation can be:
* `enabled`: Each user of the company can modify his profile. * `disabled`: No user of the company can modify his profile. |
* | fileStorageCustomisation | String | Activate/Deactivate the capability for a user to access to Rainbow file storage. Define if a user has the right to upload/download/copy or share documents. fileStorageCustomisation can be:
* `enabled`: Each user of the company can manage and share files. * `disabled`: No user of the company can manage and share files. |
* | overridePresenceCustomisation | String | Activate/Deactivate the capability for a user to change manually his presence. Define if a user has the right to change his presence manually or only use automatic states. overridePresenceCustomisation can be:
* `enabled`: Each user of the company can change his presence. * `disabled`: No user of the company can change his presence. |
* | alertNotificationReception | String | Activate/Deactivate the capability for a user to receive alert notification. Define if a user has the right to receive alert notification alertNotificationReception can be:
* `enabled`: Each user of the company can receive alert notification. * `disabled`: No user of the company can receive alert notification. |
* | alertNotificationSending | String | Activate/Deactivate the capability for a user to send alert notification. Define if a user has the right to send alert notification alertNotificationSending can be:
* `enabled`: Each user of the company can send alert notification. * `disabled`: No user of the company can send alert notification. |
* | changeTelephonyCustomisation | String | Activate/Deactivate the ability for a user to modify some telephony settings. Define if a user has the right to modify telephony settings like forward activation .... changeTelephonyCustomisation can be:
* `enabled`: The user can modify telephony settings. * `disabled`: The user can't modify telephony settings. |
* | changeSettingsCustomisation | String | Activate/Deactivate the ability for a user to change all client general settings. Define if a user has the right to change his client general settings. changeSettingsCustomisation can be:
* `enabled`: The user can change all client general settings. * `disabled`: The user can't change any client general setting. recordingConversationCustomisation Activate/Deactivate the capability for a user to record a conversation. Define if a user has the right to record a conversation (for P2P and multi-party calls). recordingConversationCustomisation can be: * `enabled`: The user can record a peer to peer or a multi-party call. * `disabled`: The user can't record a peer to peer or a multi-party call. |
* | useGifCustomisation | String | Activate/Deactivate the ability for a user to Use GIFs in conversations. Define if a user has the is allowed to send animated GIFs in conversations useGifCustomisation can be:
* `enabled`: The user can send animated GIFs in conversations. * `disabled`: The user can't send animated GIFs in conversations. |
* | useDialOutCustomisation | String | Activate/Deactivate the capability for a user to use dial out in phone meetings. Define if a user is allowed to be called by the Rainbow conference bridge. useDialOutCustomisation can be:
* `enabled`: The user can be called by the Rainbow conference bridge. * `disabled`: The user can't be called by the Rainbow conference bridge. |
* | fileCopyCustomisation | String | Activate/Deactivate the capability for a user to copy files Define if one or all users of a company is allowed to copy any file he receives in his personal cloud space. fileCopyCustomisation can be:
* `enabled`: The user can make a copy of a file to his personal cloud space. * `disabled`: The user can't make a copy of a file to his personal cloud space. |
* | fileTransferCustomisation | String | Activate/Deactivate the ability for a user to transfer files. Define if one or all users of a company has the right to copy a file from a conversation then share it inside another conversation. fileTransferCustomisation can be:
* `enabled`: The user can transfer a file doesn't belong to him. * `disabled`: The user can't transfer a file doesn't belong to him. |
* | forbidFileOwnerChangeCustomisation | String | Activate/Deactivate the ability for a user to loose the ownership on one file. Define if one or all users can drop the ownership of a file to another Rainbow user of the same company forbidFileOwnerChangeCustomisation can be:
* `enabled`: The user can't give the ownership of his file. * `disabled`: The user can give the ownership of his file. |
* | readReceiptsCustomisation | String | Activate/Deactivate the capability for a user to allow a sender to check if a chat message is read. Defines whether a peer user in a conversation allows the sender of a chat message to see if this IM is acknowledged by the peer. This right is used by Ucaas or Cpaas application to show either or not a message is acknowledged. No check is done on backend side. readReceiptsCustomisation can be:
* `enabled`: Each user of the company allow the sender to check if an IM is read. * `disabled`: No user of the company allow the sender to check if an IM is read. |
* | useSpeakingTimeStatistics | String | Activate/Deactivate the ability for a user to see speaking time statistics.. Defines whether a user has the right to see for a given meeting the speaking time for each attendee of this meeting. useSpeakingTimeStatistics can be:
* `enabled`: Each user of the company can use meeting speaking time statistics. * `disabled`: No user of the company can use meeting speaking time statistics. |
* | defaultLicenseGroup | String | Group of license to assign to user when finalizing his account (e.g. Enterprise, Business ...) |
* | defaultOptionsGroups | String\[\] | List of options to assign to user when finalizing his account (e.g. Alert ...) |
* | selectedThemeCustomers optionnel | Object | Set the selected theme(s) for customers of this BP company. This attribute only applies for BP companies. |
* | light optionnel | String | Set the selected theme light for customers of this BP company. |
* | dark optionnel | String | Set the selected theme dark for customers of this BP company. |
* | ddiReadOnly optionnel | Boolean | Indicates if admin of IR company is allowed to create or delete a DDI. Used only on IR companies. |
* | locked optionnel | Boolean | Allow to lock selected theme for customers. If true, customers won't be able to manage themes (create/update/delete). |
* | customData optionnel | Object | Company's custom data. Object with free keys/values. It is up to the client to manage the company's customData (new customData provided overwrite the existing one).
Restrictions on customData Object:
* max 10 keys, * max key length: 64 characters, * max value length: 512 characters. |
*
*/
getCompanyInfos(companyId? : string, format : string = "small", selectedThemeObj : boolean = false, name? : string, status? : string, visibility? : string, organisationId? : string, isBP? : boolean, hasBP? : boolean, bpType? : string) {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getCompanyInfos) companyId : ", that._logger.stripStringForLogs(companyId), ", format : ", format);
return new Promise((resolve, reject) => {
if (!companyId) {
let connectedUser = that.getConnectedUser() ? that.getConnectedUser():new Contact();
companyId = connectedUser.companyId;
}
that._logger.log(that.DEBUG, LOG_ID + "(getCompanyInfos) companyId : ", companyId);
that._rest.getCompanyInfos(companyId, format, selectedThemeObj, name, status, visibility, organisationId, isBP, hasBP, bpType ).then((result: any) => {
that._logger.log(that.INFO, LOG_ID + "(getCompanyInfos) company informations found on server.");
that._logger.log(that.INTERNAL, LOG_ID + "(getCompanyInfos) company informations found on server : ", result);
resolve(result);
}).catch((err) => {
return reject(err);
});
});
}
/**
* @public
* @nodered true
* @method getAvatarByContactId
* @instance
* @category Contacts INFORMATION
* @param {string} id The contact id
* @param {string} lastAvatarUpdateDate use this field to give the stored date ( could be retrieved with contact.lastAvatarUpdateDate )
* if missing or null in case where no avatar available a local module file is provided instead of URL
* @description
* Get a contact avatar by his contact id
* @return {string} Contact avatar URL or file
*/
getAvatarByContactId(id : string, lastAvatarUpdateDate : string) : string {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getAvatarByContactId) id : ", that._logger.stripStringForLogs(id), ", lastAvatarUpdateDate : ", lastAvatarUpdateDate);
if (lastAvatarUpdateDate) {
return this.avatarDomain + "/api/avatar/" + id + "?update=" + md5(lastAvatarUpdateDate);
}
return path.resolve(__dirname, "../resources/unknownContact.png");
}
/**
* @public
* @nodered true
* @method getConnectedUser
* @category Contacts INFORMATION
* @instance
* @description
* Get the connected user information
* @return {Contact} Return a Contact object representing the connected user information or null if not connected
*/
getConnectedUser(): Contact {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getConnectedUser) .");
if (!that._rest.account) {
return null;
}
/*// Create the contact object
let contact = new Contact();
//that._logger.log(that.INTERNAL, LOG_ID + "(getContactById) before updateFromUserData ", contact);
contact.updateFromUserData(that._rest.account);
contact.avatar = that.getAvatarByContactId(that._rest.account.id, that._rest.account.lastAvatarUpdateDate);
contact.status = that._presenceService.getUserConnectedPresence().presenceStatus;
contact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
// */
// Create the contact object
that.userContact.updateFromUserData(that._rest.account);
that.userContact.avatar = that.getAvatarByContactId(that._rest.account.id, that._rest.account.lastAvatarUpdateDate);
//that.userContact.status = that._presenceService.getUserConnectedPresence().presenceStatus;
//that.userContact.presence = that._presenceService.getUserConnectedPresence().presenceLevel;
return that.userContact;
}
/**
* @public
* @nodered true
* @method getDisplayName
* @instance
* @category Contacts INFORMATION
* @param {Contact} contact The contact to get display name
* @return {string} The contact first name and last name
* @description
* Get the display name of a contact
*/
getDisplayName(contact : Contact) : string {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getDisplayName) contact.id : ", that._logger.stripStringForLogs(contact?.id), ", contact.name : ", that._logger.stripStringForLogs(contact?.name?.value));
return contact.firstName + " " + contact.lastName;
}
/**
* @public
* @nodered true
* @method updateMyInformations
* @instance
* @category Contacts INFORMATION
* @param {Object} dataToUpdate :
* {
* {string} number User phone number (as entered by user). Not mandatory if the PhoneNumber to update is a PhoneNumber linked to a system (pbx)
* {string} type String Phone number type Possible values : home, work, other
* {string} deviceType String Phone number device type Possible values : landline, mobile, fax, other
* {boolean} isVisibleByOthers optionnel Boolean Allow user to choose if the phone number is visible by other users or not. Note that administrators can see all the phone numbers, even if isVisibleByOthers is set to false. Note that phone numbers linked to a system (isFromSystem=true) are always visible, isVisibleByOthers can't be set to false for these numbers.
* {string} shortNumber optionnel String [Only for update of PhoneNumbers linked to a system (pbx)] Short phone number (corresponds to the number monitored by PCG). Read only field, only used by server to find the related system PhoneNumber to update (couple shortNumber/systemId).
* {string} systemId optionnel String [Only for update of PhoneNumbers linked to a system (pbx)] Unique identifier of the system in Rainbow database to which the system PhoneNumbers belong. Read only field, only used by server to find the related system PhoneNumber to update (couple shortNumber/systemId).
* {string} internalNumber optionnel String [Only for update of PhoneNumbers linked to a system (pbx)] Internal phone number. Usable within a PBX group. By default, it is equal to shortNumber. Admins and users can modify this internalNumber field. internalNumber must be unique in the whole system group to which the related PhoneNumber belong (an error 409 is raised if someone tries to update internalNumber to a number already used by another PhoneNumber in the same system group).
* {Array} emails optionnel Object Array of user emails addresses objects
* {Array} phoneNumbers optionnel Object[] Array of user PhoneNumbers objects Notes: Provided PhoneNumbers data overwrite previous values: PhoneNumbers which are not known on server side are added, PhoneNumbers which are changed are updated, PhoneNumbers which are not provided but existed on server side are deleted. This does not applies to PhoneNumbers linked to a system(pbx), which can only be updated (addition and deletion of system PhoneNumbers are ignored). When number is present, the server tries to compute the associated E.164 number (numberE164 field) using provided PhoneNumber country if available, user country otherwise. If numberE164 can't be computed, an error 400 is returned (ex: wrong phone number, phone number not matching country code, ...) PhoneNumber linked to a system (pbx) can also be updated. In that case, shortNumber and systemId of the existing system PhoneNumber must be provided with the fields to update (see example bellow). * System phoneNumbers can't be created nor deleted using this API, only PCG can create/delete system PhoneNumbers.
* {string} selectedTheme optionnel String Theme to be used by the user If the user is allowed to (company has 'allowUserSelectTheme' set to true), he can choose his preferred theme among the list of supported themes (see https://openrainbow.com/api/rainbow/enduser/v1.0/themes).
* {string} firstName optionnel String User first name
* {string} lastName optionnel String User last name
* {string} nickName optionnel String User nickName
* {string} title optionnel String User title (honorifics title, like Mr, Mrs, Sir, Lord, Lady, Dr, Prof,...)
* {string} jobTitle optionnel String User job title
* {string} visibility optionnel String User visibility Define if the user can be searched by users being in other company and if the user can search users being in other companies. Visibility can be: same_than_company: The same visibility than the user's company's is applied to the user. When this user visibility is used, if the visibility of the company is changed the user's visibility will use this company new visibility. public: User can be searched by external users / can search external users. User can invite external users / can be invited by external users private: User can't be searched by external users / can search external users. User can invite external users / can be invited by external users closed: User can't be searched by external users / can't search external users. User can invite external users / can be invited by external users isolated: User can't be searched by external users / can't search external users. User can't invite external users / can't be invited by external users none: Default value reserved for guest. User can't be searched by any users (even within the same company) / can search external users. User can invite external users / can be invited by external users External users mean 'public user not being in user's company nor user's organisation nor a company visible by user's company. Default value : same_than_company Possible values : same_than_company, public, private, closed, isolated, none
* {boolean} isInitialized optionnel Boolean Is user initialized
* {string} timezone optionnel String User timezone name Allowed values: one of the timezone names defined in IANA tz database Timezone name are composed as follow: Area/Location (ex: Europe/Paris, America/New_York,...)
* {string} language optionnel String User language Language format is composed of locale using format ISO 639-1, with optionally the regional variation using ISO 3166‑1 alpha-2 (separated by hyphen). Locale part is in lowercase, regional part is in uppercase. Examples: en, en-US, fr, fr-FR, fr-CA, es-ES, es-MX, ... More information about the format can be found on this link.
* {string} state optionnel String When country is 'USA' or 'CAN', a state can be defined. Else it is not managed (null).
* {string} country optionnel String User country (ISO 3166-1 alpha3 format)
* {string} department optionnel String User department
* {string} email String User email address
* {string} country optionnel String Phone number country (ISO 3166-1 alpha3 format). country field is automatically computed using the following algorithm when creating/updating a phoneNumber entry: If number is provided and is in E164 format, country is computed from E164 number Else if country field is provided in the phoneNumber entry, this one is used Else user country field is used Note that in the case number field is set (but not in E164 format), associated numberE164 field is computed using phoneNumber'country field. So, number and country field must match so that numberE164 can be computed.
* {string} type String User email type Possible values : home, work, other
* {string} customData optionnel Object User's custom data. Object with free keys/values. It is up to the client to manage the user's customData (new customData provided overwrite the existing one). Restrictions on customData Object: max 20 keys, max key length: 64 characters, max value length: 4096 characters. User customData can only be created/updated by: the user himself `company_admin` or `organization_admin` of his company, `bp_admin` and `bp_finance` of his company, `superadmin`.
* }
*
* @return {string} The contact first name and last name
* @description
* This API can be used to update data of logged in user. This API can only be used by user himself (i.e. userId of logged in user = value of userId parameter in URL)
*/
updateMyInformations(dataToUpdate: any) : Promise {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(updateMyInformations) .");
// that._logger.log(that.INTERNAL, LOG_ID + "(updateMyInformations) parameters : dataToUpdate : ", dataToUpdate);
return new Promise(function (resolve, reject) {
try {
if (!dataToUpdate) {
that._logger.log(that.ERROR, LOG_ID + "(updateMyInformations) bad or empty 'dataToUpdate' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
let meId = that._rest.account.id;
that._rest.updateEndUserInformations(meId, dataToUpdate).then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(updateMyInformations) Successfully result : ", result);
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(updateMyInformations) Error when updating informations.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(updateMyInformations) Error : ", err);
return reject(err);
});
} catch (err) {
that._logger.log(that.INTERNALERROR, LOG_ID + "(updateMyInformations) error : ", err);
return reject(err);
}
});
}
//endregion Contacts INFORMATION
//region Contacts Sources
/**
* @public
* @nodered true
* @method createSource
* @instance
* @category Contacts SOURCES
* @async
* @since 2.21.0
* @return {Object} The result
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | id | String | Source unique identifier |
* | os | String | Operating system name and version |
* | sourceId | String | Id of source that could be IMEI or factory number for mobiles, email for Outloock or account number for Facebook |
*
* @description
* A client could have one or more mobile devices as a source of contacts with his contacts stored in.
* Also a source of contacts could be Microsoft Outlook / Linkedin or Facebook.
* ontacts could be used for constructing recommendation rules.
* SourceId must be unique for a given user.
* @param {string} userId User unique identifier
* @param {string} sourceId Id of source, that could be IMEI or factory number for mobiles , email for Outlook or account number for Facebook. Only one sourceId must exist by user.
* @param {string} os Operating system name and version.
*/
async createSource (userId : string, sourceId : string, os : string ) {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(createSource) userId : ", that._logger.stripStringForLogs(userId), ", sourceId : ", that._logger.stripStringForLogs(sourceId));
// that._logger.log(that.INTERNAL, LOG_ID + "(createSource) parameters : userId : ", userId);
return new Promise(function (resolve, reject) {
try {
let meId = userId ? userId : that._rest.account.id;
if (!sourceId) {
that._logger.log(that.ERROR, LOG_ID + "(createSource) bad or empty 'sourceId' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
if (!os) {
that._logger.log(that.ERROR, LOG_ID + "(createSource) bad or empty 'os' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
that._rest.createSource(meId, sourceId, os).then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(createSource) Successfully result : ", result);
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(createSource) Error when updating informations.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(createSource) Error : ", err);
return reject(err);
});
} catch (err) {
that._logger.log(that.INTERNALERROR, LOG_ID + "(createSource) error : ", err);
return reject(err);
}
});
}
/**
* @public
* @nodered true
* @method deleteSource
* @instance
* @category Contacts SOURCES
* @async
* @since 2.21.0
* @return {Object} The result
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | status | String | Deletion status |
* | data | Object\[\] | No data (empty Array) |
*
* @description
* This API is used to delete a source.
* @param {string} userId User unique identifier
* @param {string} sourceId Source unique identifier.
*/
async deleteSource (userId : string, sourceId : string) {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(deleteSource) userId : ", that._logger.stripStringForLogs(userId), ", sourceId : ", that._logger.stripStringForLogs(sourceId));
// that._logger.log(that.INTERNAL, LOG_ID + "(deleteSource) parameters : userId : ", userId);
return new Promise(function (resolve, reject) {
try {
let meId = userId ? userId : that._rest.account.id;
if (!sourceId) {
that._logger.log(that.ERROR, LOG_ID + "(deleteSource) bad or empty 'sourceId' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
that._rest.deleteSource(meId, sourceId).then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(deleteSource) Successfully result : ", result);
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(deleteSource) Error when updating informations.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(deleteSource) Error : ", err);
return reject(err);
});
} catch (err) {
that._logger.log(that.INTERNALERROR, LOG_ID + "(deleteSource) error : ", err);
return reject(err);
}
});
}
/**
* @public
* @nodered true
* @method getSourceData
* @instance
* @category Contacts SOURCES
* @async
* @since 2.21.0
* @return {Object} The result
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | id | String | Source unique identifier |
* | os | String | Operating system name and version |
* | sourceId | String | Id of source that could be IMEI or factory number for mobiles, email for Outloock or account number for Facebook |
*
* @description
* This API is used to get a source data.
* @param {string} userId User unique identifier
* @param {string} sourceId Source unique identifier.
*/
async getSourceData(userId : string, sourceId : string) {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getSourceData) userId : ", that._logger.stripStringForLogs(userId), ", sourceId : ", that._logger.stripStringForLogs(sourceId));
// that._logger.log(that.INTERNAL, LOG_ID + "(getSourceData) parameters : userId : ", userId);
return new Promise(function (resolve, reject) {
try {
let meId = userId ? userId : that._rest.account.id;
if (!sourceId) {
that._logger.log(that.ERROR, LOG_ID + "(getSourceData) bad or empty 'sourceId' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
that._rest.getSourceData(meId, sourceId).then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(getSourceData) Successfully result : ", result);
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(getSourceData) Error when updating informations.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getSourceData) Error : ", err);
return reject(err);
});
} catch (err) {
that._logger.log(that.INTERNALERROR, LOG_ID + "(getSourceData) error : ", err);
return reject(err);
}
});
}
/**
* @public
* @nodered true
* @method getAllSourcesByUserId
* @instance
* @category Contacts SOURCES
* @async
* @since 2.21.0
* @return {Object} The result
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | data | Object\[\] | sources id list is sent. |
* | id | String | |
* | limit | Number | Number of requested items |
* | offset | Number | Requested position of the first item to retrieve |
* | total | Number | Total number of items |
*
* @description
* This API is used to get all sources by userId.
* @param {string} userId User unique identifier
* @param {string} format="small" Allows to retrieve more or less source details in response.
* - small: id, sourceId
* - medium: id, sourceId, os
* - full: all source fields
* Default value : small. Possibles values : small, medium, full
* @param {string} sortField="name" Sort items list based on the given field. Default value : name
* @param {number} limit=100 Allow to specify the number of items to retrieve. Default value : 100.
* @param {number} offset=0 Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned. Default value : 0
* @param {number} sortOrder=1 Specify order when sorting items list. Default value : 1. Possibles values -1, 1.
*/
async getAllSourcesByUserId (userId? : string, format : string = "small", sortField : string = "name", limit : number = 100, offset : number = 0, sortOrder : number = 1) {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(getAllSourcesByUserId) userId : ", that._logger.stripStringForLogs(userId), ", format : ", that._logger.stripStringForLogs(format));
//that._logger.log(that.INTERNAL, LOG_ID + "(getAllSourcesByUserId) parameters : userId : ", userId);
return new Promise(function (resolve, reject) {
try {
let meId = userId ? userId : that._rest.account.id;
that._rest.getAllSourcesByUserId(meId, format, sortField, limit, offset, sortOrder).then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(getAllSourcesByUserId) Successfully result : ", result);
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(getAllSourcesByUserId) Error when updating informations.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(getAllSourcesByUserId) Error : ", err);
return reject(err);
});
} catch (err) {
that._logger.log(that.INTERNALERROR, LOG_ID + "(getAllSourcesByUserId) error : ", err);
return reject(err);
}
});
}
/**
* @public
* @nodered true
* @method updateSourceData
* @instance
* @category Contacts SOURCES
* @async
* @since 2.21.0
* @return {Object} The result
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | id | String | Source unique identifier |
* | os | String | Operating system name and version |
* | sourceId | String | Id of source that could be IMEI or factory number for mobiles, email for Outloock or account number for Facebook |
*
* @description
* This API is used to update a source data.
* @param {string} userId User unique identifier
* @param {string} sourceId Source unique identifier
* @param {string} os Operating system name and version.
*/
async updateSourceData (userId : string, sourceId : string, os : string ) {
let that = this;
that._logger.log(that.INFOAPI, LOG_ID + API_ID + "(updateSourceData) userId : ", that._logger.stripStringForLogs(userId), ", sourceId : ", that._logger.stripStringForLogs(sourceId));
// that._logger.log(that.INTERNAL, LOG_ID + "(updateSourceData) parameters : userId : ", userId);
return new Promise(function (resolve, reject) {
try {
let meId = userId ? userId : that._rest.account.id;
if (!sourceId) {
that._logger.log(that.ERROR, LOG_ID + "(updateSourceData) bad or empty 'sourceId' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
if (!os) {
that._logger.log(that.ERROR, LOG_ID + "(updateSourceData) bad or empty 'os' parameter");
reject(ErrorManager.getErrorManager().BAD_REQUEST);
return;
}
that._rest.updateSourceData(meId, sourceId, os).then((result) => {
that._logger.log(that.INTERNAL, LOG_ID + "(updateSourceData) Successfully result : ", result);
resolve(result);
}).catch((err) => {
that._logger.log(that.ERROR, LOG_ID + "(updateSourceData) Error when updating informations.");
that._logger.log(that.INTERNALERROR, LOG_ID + "(updateSourceData) Error : ", err);
return reject(err);
});
} catch (err) {
that._logger.log(that.INTERNALERROR, LOG_ID + "(updateSourceData) error : ", err);
return reject(err);
}
});
}
//endregion Contacts Sources
//region Contacts API - Enduser portal
/**
* @public
* @nodered true
* @method updateContactData
* @instance
* @category Contacts Contacts API - Enduser portal
* @async
* @since 2.21.0
* @return {Object} The result
*
*
* | Champ | Type | Description |
* | --- | --- | --- |
* | id | String | Contact unique identifier |
* | contactId | String | Id of the contact coming from the source who created it |
* | firstName | String | Contact firstName |
* | lastName | String | Contact lastName |
* | displayName | String | Contact displayName |
* | company | String | Contact company |
* | jobTitle | String | Contact jobTitle |
* | phoneNumbers | Object\[\] | Contact phone numbers |
* | type | String | Phone number type
Possibles values `home`, `work`, `other` |
* | address | String | Contact address |
* | street | String | Contact street |
* | city | String | Contact city |
* | state | String | Contact state |
* | postalCode | String | Contact postalCode |
* | country | String | Contact country |
* | groups | String\[\] | Contact groups type
Possibles values `home`, `work`, `other` |
* | otherData | Object\[\] | Other user data – may include birthday date, Skype/Facebook pseudo/profile |
* | key | String | Other user data key |
* | value | String | Other user data value |
*
* @description
* This API is used to update a contact data.
* @param {string} userId User unique identifier
* @param {string} sourceId Source unique identifier
* @param {string} contactIddb Contact unique identifier
* @param {string} contactId Contact unique id used by target mobile
* @param {string} firstName First name
* @param {string} lastName Last name
* @param {string} displayName First/last name, some OS don’t mind to have it in two attribute
* @param {string} company Company name
* @param {string} jobTitle Job title
* @param {Array