Class ServerObjectExtensionAttribute
- Namespace
- ESRI.Server.SOESupport
- Assembly
- ESRI.Server.SOESupport.dll
Use ServerObjectExtension attribute to annotate main SOE class that implements IServerObjectExtension. An Add-in package can have multiple ServerObjectExtension classes but it is not recommended.
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public class ServerObjectExtensionAttribute : Attribute
- Inheritance
-
ServerObjectExtensionAttribute
- Inherited Members
Constructors
ServerObjectExtensionAttribute(string)
ServerObjectExtension attribute constructor.
public ServerObjectExtensionAttribute(string serverobject)
Parameters
serverobjectstringType of the server object that this SOE was designed for. Example: 'MapServer'.
Properties
AllCapabilities
All web capabilities in a comma-separated list.
public virtual string AllCapabilities { get; set; }
Property Value
DefaultCapabilities
Default set of web capabilities in comma-separated list. Subset of AllCapabilities.
public virtual string DefaultCapabilities { get; set; }
Property Value
Description
SOE description.
public virtual string Description { get; set; }
Property Value
DisplayName
SOE display name that you will see in Manager or other admin client.
public virtual string DisplayName { get; set; }
Property Value
HasManagerPropertiesConfigurationPane
Set this flag to true if you have custom JS widged for the SOE properties pane in Manager.
public virtual bool HasManagerPropertiesConfigurationPane { get; set; }
Property Value
Properties
SOE properties.
public virtual string Properties { get; set; }
Property Value
SOAPNamespaceURI
Sets SOAP namespace URI for the add-in configuration.
public virtual string SOAPNamespaceURI { get; set; }
Property Value
Examples
This example shows how to define SOAP namespace URI for SOE.
[ComVisible(true)]
[Guid("ff21a501-5eb9-406a-aab1-29389d25b868")]
[ClassInterface(ClassInterfaceType.None)]
[ServerObjectExtension("MapServer",
AllCapabilities = "GetInfo,FindFeatures,DemoCustomObject,DemoArrayOfCustomObjects",
DefaultCapabilities = "GetInfo,DemoCustomObject,DemoArrayOfCustomObjects",
Description = ".NET Find Near Features SOAP SOE Sample",
DisplayName = ".NET Find Near Features Soap SOE",
Properties = "",
SupportsREST = false,
SupportsSOAP = true,
SOAPNamespaceURI = "http://examples.esri.com/schemas/NetFindNearFeaturesSoapSOE/1.0")]
ServerObjectType
Type of the server object that this SOE was designed for. Example: 'MapServer'.
public virtual string ServerObjectType { get; set; }
Property Value
SupportsREST
Shows that SOE supports REST API. Default is false.
public virtual bool SupportsREST { get; set; }
Property Value
SupportsSOAP
Shows that SOE supports SOAP API. Default is false.
public virtual bool SupportsSOAP { get; set; }
Property Value
SupportsSharedInstances
Shows that SOE supports deployment to Shared Instances host. Default is false.
public virtual bool SupportsSharedInstances { get; set; }