Add definition for "angular-google-analytics".

2026-09-09 11:13:57 +08:00 · 2015-11-18 10:29:10 +01:00
parent fc341765eb
commit 597b116c31
2 changed files with 229 additions and 0 deletions
@@ -0,0 +1,56 @@
+/// <reference path="angular-google-analytics.d.ts" />
+
+function ConfigurationMethodChaining(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider
+        .logAllCalls(true)
+        .startOffline(true)
+        .useECommerce(true, true);
+}
+
+function EnableECommerce(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.useECommerce(true, false);
+    AnalyticsProvider.useECommerce(true, true);
+    AnalyticsProvider.setCurrency("CDN");
+}
+
+function SetGoogleAnalyticsAccounts(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.setAccount("UA-XXXXX-xx");
+    AnalyticsProvider.setAccount([
+        { tracker: "UA-12345-12", name: "tracker1" },
+        { tracker: "UA-12345-34", name: "tracker2" }
+    ]);
+}
+
+function UseClassicAnalytics(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.useAnalytics(false);
+}
+
+function UseDisplayFeatures(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.useDisplayFeatures(true);
+}
+
+function UseEnhancedLinkAttribution(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.useEnhancedLinkAttribution(true);
+}
+
+function UseCrossDomainLinking(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.useCrossDomainLinker(true);
+    AnalyticsProvider.setCrossLinkDomains(["domain-1.com", "domain-2.com"]);
+}
+
+function SetCookieConfiguration(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.setCookieConfig({
+        cookieDomain: "foo.example.com",
+        cookieName: "myNewName",
+        cookieExpires: 20000
+    });
+}
+
+function SetRouteTrackingBehaviors(AnalyticsProvider: angular.google.analytics.IAnalyticsProvider) {
+    AnalyticsProvider.trackPages(true);
+    AnalyticsProvider.trackUrlParams(true);
+    AnalyticsProvider.ignoreFirstPageLoad(true);
+    AnalyticsProvider.trackPrefix("my-application");
+    AnalyticsProvider.setPageEvent("$stateChangeSuccess");
+    AnalyticsProvider.setRemoveRegExp(/\/\d+?$/);
+}
@@ -0,0 +1,173 @@
+// Type definitions for angular-google-analytics v1.1.0
+// Project: https://github.com/revolunet/angular-google-analytics
+// Definitions by: Cyril Schumacher <https://github.com/cyrilschumacher>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module angular.google.analytics {
+    /**
+     * @summary Interface for {@link AnalysticsProvider}.
+     * @interface
+     */
+    interface IAnalyticsProvider {
+        /**
+         * @summary Use Delay Script Tag Insertion.
+         * @param {boolean} val If true, the delay script tag is inserted.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        delayScriptTag(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Activates the test mode.
+         */
+        enterTestMode(): void;
+
+        /**
+         * @summary Gets the global cookie configuration.
+         * @return {Object} The global cookie configuration.
+         */
+        getCookieConfig(): Object;
+
+        /**
+         * @summary Ignore first page view.
+         * @param {boolean} val If true, the first page view is ignored.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        ignoreFirstPageLoad(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Enable Service Logging.
+         * @param {boolean} val If true, log all outbound calls to an in-memory array accessible.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        logAllCalls(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Set Google Analytics Accounts.
+         * @param {Object} tracker The account identifier(s).
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        setAccount(tracker: string|Object|Array<Object>): IAnalyticsProvider;
+
+        /**
+         * @summary Set Cookie Configuration.
+         * @param {Object} config The custom cookie parameters.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         * @deprecated
+         */
+        setCookieConfig(config: Object): IAnalyticsProvider;
+
+        /**
+         * @summary Set cross-linked domains.
+         * @param {Array<string>} domains The domains.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        setCrossLinkDomains(domains: Array<string>): IAnalyticsProvider;
+
+        /**
+         * @summary Set currency.
+         * @param {string} currencyCode The currency code.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        setCurrency(currencyCode: string): IAnalyticsProvider;
+
+        /**
+         * @summary Set Domain Name.
+         * @param {string} domain The domain name.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        setDomainName(domain: string): IAnalyticsProvider;
+
+        /**
+         * @summary Enable Experiment (universal analytics only).
+         * @param {string} id The experiment identifier.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        setExperimentId(id: string): IAnalyticsProvider;
+
+        /**
+         * @summary Support Hybrid Mobile Applications.
+         * @param {boolean} val If true, each account object will disable protocol checking and all injected scripts will use the HTTPS protocol.
+         */
+        setHybridMobileSupport(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Set the default page event name.
+         * @param {string} name The default page event name.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        setPageEvent(name: string): IAnalyticsProvider;
+
+        /**
+         * @summary Sets the regex to scrub location before sending to analytics.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         * @param {RegExp} regex The regex.
+         */
+        setRemoveRegExp(regex: RegExp): IAnalyticsProvider;
+
+        /**
+         * @summary Starts the offline mode.
+         * @param {boolean} val If true, the offline mode is started.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        startOffline(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Track all routes.
+         * @param {boolean} val If true, all routes are tracked.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        trackPages(doTrack: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Sets the URL prefix.
+         * @param {string} prefix The URL prefix.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        trackPrefix(prefix: string): IAnalyticsProvider;
+
+        /**
+         * @summary Track all URL query parameters.
+         * @param {boolean} val If true, all URL query parameters are tracked.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        trackUrlParams(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Use Classic Analytics.
+         * @param {boolean} val If true, use classic analytics.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        useAnalytics(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Use Cross Domain Linking.
+         * @param {boolean} val If true, the cross-linked domains are registered with Google Analytics.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        useCrossDomainLinker(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Use Display Features.
+         * @param {boolean} val If true, the display features module is loaded with Google Analytics.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        useDisplayFeatures(val: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Enable enhanced e-commerce module.
+         * @param {boolean} val If true, the enhanced e-commerce module is enabled.
+         * @param {boolean} enhanced If true, the "ec.js" file is used, otherwises, the "ecommerce.js" is used.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        useECommerce(val: boolean, enhanced: boolean): IAnalyticsProvider;
+
+        /**
+         * @summary Use Enhanced Link Attribution.
+         * @param {boolean} val If true, the enhanced link attribution module is loaded with Google Analytics.
+         * @return {angular.google.analytics.IAnalyticsProvider} The object instance.
+         */
+        useEnhancedLinkAttribution(val: boolean): IAnalyticsProvider;
+    }
+}