MultiServerService

Public Class

This class represents a multi-server service inside Revit application. It is created when an instance of IMultiServerService is registered with Revit.

Inheritance Hierarchy

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

Namespace: Autodesk.Revit.DB.ExternalService

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

Syntax

public class MultiServerService : ExternalService

The MultiServerService type exposes the following members.

Properties

Name

Description

---

Public Property

Description

The description for the service
(Inherited from ExternalService)

---

Public Property
ExecutionPolicy

Specifies how a multi-server service executes servers during its execution.

---

Public Property
IsSerializable

Indicates whether executions of the service requires serialization in documents or not.
(Inherited from ExternalService)

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from ExternalService)

---

Public Property

Name

The name of the service
(Inherited from ExternalService)

---

Public Property
NumberOfServers

Indicates the number of servers currently registered with the service.
(Inherited from ExternalService)

---

Public Property

ServiceId

The Id of the service
(Inherited from ExternalService)

---

Public Property
SupportActivation

Indicates if the service supports activation/deactivation of the servers.
(Inherited from ExternalService)

---

Public Property

VendorId

The vendor who provided the service
(Inherited from ExternalService)

---

Methods

Name

Description

---

Public Method
AddServer

Registers a server with its service.
(Inherited from ExternalService)

---

Public Method

Dispose

(Inherited from ExternalService)

---

Public Method

Equals

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

---

Public Method
GetActiveServerIds.

Returns Ids of the currently active application-level servers registered for the service.

---

Public Method
GetActiveServerIds(Document)

Returns Ids of the servers currently applicable to the given document for the service.

---

Public Method
GetDefaultServerId

Returns the Id of the default server if one was assigned to the service.
(Inherited from ExternalService)

---

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.
(Inherited from ExternalService)

---

Public Method
GetPublicAccessKey

Access key to use to execute a service.
(Inherited from ExternalService)

---

Public Method
GetRegisteredServerIds

Returns Ids of all servers registered for the service.
(Inherited from ExternalService)

---

Public Method

GetServer

Returns the instance that provides implementation for a registered server.
(Inherited from ExternalService)

---

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.
(Inherited from ExternalService)

---

Public Method
RemoveServer

Removes/unregisters a server from the service.
(Inherited from ExternalService)

---

Public Method
SetActiveServers(IList.Guid.)

Changes the active servers and/or their order.

---

Public Method
SetActiveServers(IList.Guid., Document)

Changes the active servers and/or their order for the given document.

---

Public Method
SetServerState

This method will simply switch the active state of a server without affecting in any way the other servers.

---

Public Method

ToString

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

---