GetExpirationMethod Method (StreamLayer)

In This Topic

Gets the current expiration method. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function GetExpirationMethod() As FeatureExpirationMethod

public FeatureExpirationMethod GetExpirationMethod()

Return Value

ArcGIS.Core.CIM.FeatureExpirationMethod

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.InvalidOperationException	Stream service data connection is null.

Example

Set the Maximum Count of Previous Observations to be Stored in Memory

{
  // Note: call within QueuedTask.Run()
  {
    //Set Expiration Method and Max Expiration Count
    if (streamLayer.GetExpirationMethod() != FeatureExpirationMethod.MaximumFeatureCount)
      streamLayer.SetExpirationMethod(FeatureExpirationMethod.MaximumFeatureCount);
    streamLayer.SetExpirationMaxCount(15);
    //FYI
    if (streamLayer.IsTrackAware)
    {
      //MaxCount is per track! otherwise for the entire layer
    }
  }
}

Set the Maximum Age of Previous Observations to be Stored in Memory

{
  // Note: call within QueuedTask.Run()
  {
    //Set Expiration Method and Max Expiration Age
    if (streamLayer.GetExpirationMethod() != FeatureExpirationMethod.MaximumFeatureAge)
      streamLayer.SetExpirationMethod(FeatureExpirationMethod.MaximumFeatureAge);
    //set to 12 hours (max is 24 hours)
    streamLayer.SetExpirationMaxAge(new TimeSpan(12, 0, 0));

    //FYI
    if (streamLayer.IsTrackAware)
    {
      //MaxAge is per track! otherwise for the entire layer
    }
  }
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

StreamLayer Class
StreamLayer Members

Send feedback