ExternalService

Description:
This base class represents an external service inside Revit application.

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

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ExternalService.ExternalService
    Autodesk.Revit.DB.ExternalService.MultiServerService
    Autodesk.Revit.DB.ExternalService.SingleServerService

public class ExternalService : IDisposable

Public Class ExternalService
	Implements IDisposable

public ref class ExternalService : IDisposable

type ExternalService = 
    class
        interface IDisposable
    end

Name	Return Type	Description	Inherited From
M AddServer(IExternalServer)	None	Registers a server with its service.
M Dispose()	None	Releases all resources used by the ExternalService
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetDefaultServerId()	Guid	Returns the Id of the default server if one was assigned to the service.
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetOptions()	ExternalServiceOptions	A copy of the options the service was registered with.
M GetPublicAccessKey()	Guid	Access key to use to execute a service.
M GetRegisteredServerIds()	IList<Guid>	Returns Ids of all servers registered for the service.
M GetServer(Guid)	IExternalServer	Returns the instance that provides implementation for a registered server.
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M IsRegisteredServerId(Guid)	Boolean	Checks if the Id represents a valid server that has been registered for the service.
M RemoveServer(Guid)	None	Removes/unregisters a server from the service.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P Description	string	The description for the service
P IsSerializable	bool	Indicates whether executions of the service requires serialization in documents or not.
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P Name	string	The name of the service
P NumberOfServers	int	Indicates the number of servers currently registered with the service.
P ServiceId	ExternalServiceId	The Id of the service
P SupportActivation	bool	Indicates if the service supports activation/deactivation of the servers.
P VendorId	string	The vendor who provided the service