Source: portlet/register.es.js

  1. /**
  2.  * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
  3.  *
  4.  * This library is free software; you can redistribute it and/or modify it under
  5.  * the terms of the GNU Lesser General Public License as published by the Free
  6.  * Software Foundation; either version 2.1 of the License, or (at your option)
  7.  * any later version.
  8.  *
  9.  * This library is distributed in the hope that it will be useful, but WITHOUT
  10.  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11.  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  12.  * details.
  13.  */
  15. import PortletInit from './PortletInit.es';
  16. import {validateArguments, validatePortletId} from './portlet_util.es';
  18. /**
  19.  * Registers a portlet client with the portlet hub.
  20.  * @param {string} portletId The unique portlet identifier
  21.  * @return {Promise} A Promise object. Returns an {@link PortletInit} object
  22.  * containing functions for use by the portlet client on successful resolution.
  23.  * Returns an Error object containing a descriptive message on failure.
  24.  * @review
  25.  */
  27. const register = function (portletId) {
  28. 	validateArguments(arguments, 1, 1, ['string']);
  30. 	const pageRenderState = global.portlet.data.pageRenderState;
  32. 	return new Promise((resolve, reject) => {
  33. 		if (validatePortletId(pageRenderState, portletId)) {
  34. 			resolve(new PortletInit(portletId));
  35. 		}
  36. 		else {
  37. 			reject(new Error('Invalid portlet ID'));
  38. 		}
  39. 	});
  40. };
  42. export {register};
  43. export default register;