RestSOIHelper Class

The RestSOIHelper class is a utility class that helps to implement REST request handling in SOIs.


Constructors

NameDescription
RestSOIHelper(IServerObjectHelper)The RestSOIHelper constructor accepts reference to IServerObjectHelper and should be called from the IServerObjectExtension.Init implementation.

RestSOIHelper(IServerObjectHelper) Constructor

The RestSOIHelper constructor accepts reference to IServerObjectHelper and should be called from the IServerObjectExtension.Init implementation.

Use dark colors for code blocksCopy
1
public RestSOIHelper(ESRI.ArcGIS.Server.IServerObjectHelper soHelper)
ParameterDescription
soHelperNon-null reference to the IServerObjectHelper instance.

Properties

PropertyProperty valueDescription
RestSOIHelper.FilterMapDictionary<RestHandlerOpCode, RestFilter>Map of REST request filters for every REST request code.

Methods

NameDescription
RestSOIHelper.GetFilter(RestHandlerOpCode)GetFilter returns filter set for the REST request or null if there is no filter set.
RestSOIHelper.GetHandlerOpCode(String, String)The GetHandlerOpCode method parses REST resource and operation name parameters and returns corresponding RestHandlerOpCode.

RestSOIHelper.GetFilter(RestHandlerOpCode) Method

GetFilter returns filter set for the REST request or null if there is no filter set. This method F=returns the filter of the REST request or null if there is no filter set.

Use dark colors for code blocksCopy
1
public RestFilter GetFilter(RestHandlerOpCode opCode)
ParameterDescription
opCodeAn unique identifier of the REST request specified in RestHandlerOpCode and/or derived types.

RestSOIHelper.GetHandlerOpCode(String, String) Method

The GetHandlerOpCode method parses REST resource and operation name parameters and returns corresponding RestHandlerOpCode. This method returns the value of RestHandlerOpCode or RestHandlerOpCode.DefaultNoOp if resource and operation string pair does not match any pre-defined values of RestHandlerOpCode.

Use dark colors for code blocksCopy
1
public static RestHandlerOpCode GetHandlerOpCode(string resourceName, string operationName)
ParameterDescription
resourceNameREST resource name passed to HandleRESTRequest
operationNameREST operation name passed to HandleRESTRequest

Inheritance Hierarchy

Inheritance: ESRI.Server.SOESupport.SOI.SOIBase → ESRI.Server.SOESupport.SOI.RestSOIHelper

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.