ExternalService

Public Class

This base class represents an external service inside Revit application.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ExternalService.ExternalService
Autodesk.Revit.DB.ExternalService.MultiServerService
Autodesk.Revit.DB.ExternalService.SingleServerService

Namespace: Autodesk.Revit.DB.ExternalService

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class ExternalService : IDisposable

The ExternalService type exposes the following members.

Properties

Name

Description

---

Public Property

Description

The description for the service

---

Public Property
IsSerializable

Indicates whether executions of the service requires serialization in documents or not.

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Public Property

Name

The name of the service

---

Public Property
NumberOfServers

Indicates the number of servers currently registered with the service.

---

Public Property

ServiceId

The Id of the service

---

Public Property
SupportActivation

Indicates if the service supports activation/deactivation of the servers.

---

Public Property

VendorId

The vendor who provided the service

---

Methods

Name

Description

---

Public Method
AddServer

Registers a server with its service.

---

Public Method

Dispose

Releases all resources used by the ExternalService

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method
GetDefaultServerId

Returns the Id of the default server if one was assigned to the service.

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method
GetOptions

A copy of the options the service was registered with.

---

Public Method
GetPublicAccessKey

Access key to use to execute a service.

---

Public Method
GetRegisteredServerIds

Returns Ids of all servers registered for the service.

---

Public Method

GetServer

Returns the instance that provides implementation for a registered server.

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

IsRegisteredServerId

Checks if the Id represents a valid server that has been registered for the service.

---

Public Method
RemoveServer

Removes/unregisters a server from the service.

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

This is a base class from which SingleServerService and MultiServerService classes are inherited. It implements all basic methods, but the two inherited classes add more methods specific for that kind of service the class represents. Use this base class to get information about a service and its servers. Use the specific inherited classes to set or get active servers.

Summary of common methods:

• Adding and removing a server to and from a service
• Getting information about a service
• Querying a number of servers registered for a service
• Accessing servers currently registered for a service

Summary of the service-specific methods:

• Getting and setting active server (or servers) for a service