com.rapidclipse.framework.server.webapi.device.Device Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2013-2023 by XDEV Software, All Rights Reserved.
 *
 * This file is part of the RapidClipse Application Platform (RAP).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 *
 * Contributors:
 *     XDEV Software - initial API and implementation
 */
package com.rapidclipse.framework.server.webapi.device;

import com.rapidclipse.framework.server.webapi.JsonUtils;
import com.vaadin.flow.component.UI;


/*
 * Collection of functionalities that don't belong anywhere specific and are too small to be grouped together into
 * something seperate.
 */
/**
 * Various device functionalities.
 *
 * @author XDEV Software
 * @since 10.02.00
 */
public final class Device
{
	/**
	 * Let the device vibrate with the given pattern.

	 *
	 * @param vibrationPattern
	 *            The pattern is built as follows: length, pause, length, pause etc.

	 *            For example 100, 200, 300 would vibrate for 100ms then pause for 200 and then vibrate for 300ms again.
	 */
	public static void vibrate(final int... vibrationPattern)
	{
		UI.getCurrent()
			.getPage()
			.executeJs("navigator.vibrate($0)", JsonUtils.encodeObject(vibrationPattern));
	}

	/**
	 * Let the user select to share the given url to a device specific list of apps. If it is shared e.g. to the
	 * clipboard, only the url will be copied.
	 *
	 * @param url
	 *            The url that should be shared.
	 * @param title
	 *            A title that may be displayed.
	 * @param text
	 *            A description that may be displayed.
	 */
	public static void shareUrl(final String url, final String title, final String text)
	{
		UI.getCurrent()
			.getPage()
			.executeJs("if('share' in navigator) { navigator.share({url: $0, title: $1, text: $2}); }",
				url,
				title,
				text);
	}

	private Device()
	{
		throw new Error();
	}
}