123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.track = track;
- var _CoreManager = _interopRequireDefault(require("./CoreManager"));
- function _interopRequireDefault(obj) {
- return obj && obj.__esModule ? obj : {
- default: obj
- };
- }
- /**
- * Copyright (c) 2015-present, Parse, LLC.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @flow
- */
- /**
- * Parse.Analytics provides an interface to Parse's logging and analytics
- * backend.
- *
- * @class Parse.Analytics
- * @static
- * @hideconstructor
- */
- /**
- * Tracks the occurrence of a custom event with additional dimensions.
- * Parse will store a data point at the time of invocation with the given
- * event name.
- *
- * Dimensions will allow segmentation of the occurrences of this custom
- * event. Keys and values should be {@code String}s, and will throw
- * otherwise.
- *
- * To track a user signup along with additional metadata, consider the
- * following:
- * <pre>
- * var dimensions = {
- * gender: 'm',
- * source: 'web',
- * dayType: 'weekend'
- * };
- * Parse.Analytics.track('signup', dimensions);
- * </pre>
- *
- * There is a default limit of 8 dimensions per event tracked.
- *
- * @method track
- * @name Parse.Analytics.track
- * @param {String} name The name of the custom event to report to Parse as
- * having happened.
- * @param {Object} dimensions The dictionary of information by which to
- * segment this event.
- * @return {Promise} A promise that is resolved when the round-trip
- * to the server completes.
- */
- function track(name
- /*: string*/
- , dimensions
- /*: { [key: string]: string }*/
- )
- /*: Promise*/
- {
- name = name || '';
- name = name.replace(/^\s*/, '');
- name = name.replace(/\s*$/, '');
- if (name.length === 0) {
- throw new TypeError('A name for the custom event must be provided');
- }
- for (const key in dimensions) {
- if (typeof key !== 'string' || typeof dimensions[key] !== 'string') {
- throw new TypeError('track() dimensions expects keys and values of type "string".');
- }
- }
- return _CoreManager.default.getAnalyticsController().track(name, dimensions);
- }
- const DefaultController = {
- track(name, dimensions) {
- const RESTController = _CoreManager.default.getRESTController();
- return RESTController.request('POST', 'events/' + name, {
- dimensions: dimensions
- });
- }
- };
- _CoreManager.default.setAnalyticsController(DefaultController);
|