You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

JitsiConnection.js 4.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. const JitsiConference = require('./JitsiConference');
  2. import * as JitsiConnectionEvents from './JitsiConnectionEvents';
  3. import XMPP from './modules/xmpp/xmpp';
  4. const Statistics = require('./modules/statistics/statistics');
  5. /**
  6. * Creates new connection object for the Jitsi Meet server side video conferencing service. Provides access to the
  7. * JitsiConference interface.
  8. * @param appID identification for the provider of Jitsi Meet video conferencing services.
  9. * @param token the JWT token used to authenticate with the server(optional)
  10. * @param options Object with properties / settings related to connection with the server.
  11. * @constructor
  12. */
  13. function JitsiConnection(appID, token, options) {
  14. this.appID = appID;
  15. this.token = token;
  16. this.options = options;
  17. this.xmpp = new XMPP(options, token);
  18. this.addEventListener(JitsiConnectionEvents.CONNECTION_FAILED,
  19. (errType, msg) => {
  20. // sends analytics and callstats event
  21. Statistics.sendEventToAll(`connection.failed.${errType}`,
  22. {label: msg});
  23. });
  24. this.addEventListener(JitsiConnectionEvents.CONNECTION_DISCONNECTED,
  25. msg => {
  26. // we can see disconnects from normal tab closing of the browser
  27. // and then there are no msgs, but we want to log only disconnects
  28. // when there is real error
  29. if(msg) {
  30. Statistics.analytics.sendEvent(
  31. `connection.disconnected.${msg}`);
  32. }
  33. Statistics.sendLog(
  34. JSON.stringify({id: 'connection.disconnected', msg}));
  35. });
  36. }
  37. /**
  38. * Connect the client with the server.
  39. * @param options {object} connecting options
  40. * (for example authentications parameters).
  41. */
  42. JitsiConnection.prototype.connect = function(options) {
  43. if(!options) {
  44. options = {};
  45. }
  46. this.xmpp.connect(options.id, options.password);
  47. };
  48. /**
  49. * Attach to existing connection. Can be used for optimizations. For example:
  50. * if the connection is created on the server we can attach to it and start
  51. * using it.
  52. *
  53. * @param options {object} connecting options - rid, sid and jid.
  54. */
  55. JitsiConnection.prototype.attach = function(options) {
  56. this.xmpp.attach(options);
  57. };
  58. /**
  59. * Disconnect the client from the server.
  60. */
  61. JitsiConnection.prototype.disconnect = function(...args) {
  62. // XXX Forward any arguments passed to JitsiConnection.disconnect to
  63. // XMPP.disconnect. For example, the caller of JitsiConnection.disconnect
  64. // may optionally pass the event which triggered the disconnect in order to
  65. // provide the implementation with finer-grained context.
  66. this.xmpp.disconnect(...args);
  67. };
  68. /**
  69. * This method allows renewal of the tokens if they are expiring.
  70. * @param token the new token.
  71. */
  72. JitsiConnection.prototype.setToken = function(token) {
  73. this.token = token;
  74. };
  75. /**
  76. * Creates and joins new conference.
  77. * @param name the name of the conference; if null - a generated name will be
  78. * provided from the api
  79. * @param options Object with properties / settings related to the conference
  80. * that will be created.
  81. * @returns {JitsiConference} returns the new conference object.
  82. */
  83. JitsiConnection.prototype.initJitsiConference = function(name, options) {
  84. return new JitsiConference({name, config: options, connection: this});
  85. };
  86. /**
  87. * Subscribes the passed listener to the event.
  88. * @param event {JitsiConnectionEvents} the connection event.
  89. * @param listener {Function} the function that will receive the event
  90. */
  91. JitsiConnection.prototype.addEventListener = function(event, listener) {
  92. this.xmpp.addListener(event, listener);
  93. };
  94. /**
  95. * Unsubscribes the passed handler.
  96. * @param event {JitsiConnectionEvents} the connection event.
  97. * @param listener {Function} the function that will receive the event
  98. */
  99. JitsiConnection.prototype.removeEventListener = function(event, listener) {
  100. this.xmpp.removeListener(event, listener);
  101. };
  102. /**
  103. * Returns measured connectionTimes.
  104. */
  105. JitsiConnection.prototype.getConnectionTimes = function() {
  106. return this.xmpp.connectionTimes;
  107. };
  108. /**
  109. * Adds new feature to the list of supported features for the local
  110. * participant.
  111. * @param {String} feature the name of the feature.
  112. * @param {boolean} submit if true - the new list of features will be
  113. * immediately submitted to the others.
  114. */
  115. JitsiConnection.prototype.addFeature = function(feature, submit = false) {
  116. return this.xmpp.caps.addFeature(feature, submit);
  117. };
  118. /**
  119. * Removes a feature from the list of supported features for the local
  120. * participant
  121. * @param {String} feature the name of the feature.
  122. * @param {boolean} submit if true - the new list of features will be
  123. * immediately submitted to the others.
  124. */
  125. JitsiConnection.prototype.removeFeature = function(feature, submit = false) {
  126. return this.xmpp.caps.removeFeature(feature, submit);
  127. };
  128. module.exports = JitsiConnection;