com.microsoft.applicationinsights.telemetry.PageViewTelemetry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of applicationinsights-core Show documentation

This is the core module of Microsoft Application Insights Java SDK

The newest version!

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.applicationinsights.telemetry;

import com.microsoft.applicationinsights.internal.schemav2.PageViewData;
import java.net.URI;
import java.util.concurrent.ConcurrentMap;

/**
 * Telemetry type used to track page views.
 *
 * You can send information about pages viewed by your application to Application Insights by
 * passing an instance of this class to the 'trackPageView' method of the {@link
 * com.microsoft.applicationinsights.TelemetryClient}
 */
public final class PageViewTelemetry extends BaseTelemetry {

  private final PageViewData data;

  /** Initializes a new instance of the class with the specified {@code pageName}. */
  public PageViewTelemetry(String pageName) {
    this();
    setName(pageName);
  }

  public PageViewTelemetry() {
    data = new PageViewData();
    initialize(data.getProperties());
  }

  /** Sets the name of the page view. */
  public void setName(String name) {
    data.setName(name);
  }

  /** Gets the name of the page view. */
  public String getName() {
    return data.getName();
  }

  /** Gets the page view Uri. */
  public URI getUri() {
    return data.getUri();
  }

  /** Sets the page view Uri. */
  public void setUrl(URI uri) {
    data.setUri(uri);
  }

  /** Gets the page view duration. */
  public long getDuration() {
    return data.getDuration();
  }

  /** Sets the page view duration. */
  public void setDuration(long duration) {
    data.setDuration(duration);
  }

  /** Gets a dictionary of custom defined metrics. */
  public ConcurrentMap getMetrics() {
    return data.getMeasurements();
  }

  @Override
  protected PageViewData getData() {
    return data;
  }
}