com.worklight.adapters.rest.api.AnalyticsAPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of adapter-maven-api Show documentation

IBM MFP Adapter api for adapter as a maven project. BuildNumber is : 8.0.2024082809

The newest version!

/*
* © Copyright IBM Corp. 2016
* All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
*/

package com.worklight.adapters.rest.api;

/**
 * API for reporting information to analytics. 
 *@deprecated This interface is deprecated since V8.0, use {@link com.ibm.mfp.adapter.api.AnalyticsAPI} instead.
 */


@SuppressWarnings("deprecation")

@Deprecated
public interface AnalyticsAPI {
	/**
	 * Report user activity. This method is used to report user activity for
	 * auditing or reporting purposes. The IBM® Worklight® server maintains a
	 * separate database table to store application statistics.
	 * 
	 * 
	 * Note: To ensure that the activity is stored in the database, set
	 * reports.exportRawData to true in the worklight.properties file.
	 * 
	 * 
	 * Partially deprecated since V7.0. The client-side logActivity methods (on iOS, Android, and JavaScript)
	 * and the server-side database (the Reports database) used to store the String are deprecated.  Use
	 * the Logger client-side methods and the Operational Analytics feature instead.  Note that native Windows8,
	 * WindowsPhone8, and J2ME environments did not deprecate logActivity because there is currently no Logger
	 * support on those platforms. Those environments will continue to make use of this interface.  In 
	 * V7.0 and recent previous releases, the data from logActivity is sent to the Operational Analytics
	 * feature in addition to the (now deprecated) Reports database.
	 * 
	 * @param activityType
	 *            - A string that identifies the activity.
	 * 
	 * 
	 */
	 void logActivity(String activityType) throws MFPServerOperationException;

}