2022 Class
Changes 0
C

SingleServerService

Description:
This class represents a single-server service inside Revit application. It is created when an instance of ISingleServerService is registered with Revit.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ExternalService.ExternalService
    Autodesk.Revit.DB.ExternalService.SingleServerService
Name Return Type Description Inherited From
M GetActiveServerId() Guid Returns the Id of the currently active application-level server of the service.
M GetActiveServerId(Document) Guid Returns the Id of the server currently associated with the given document for the service.
M SetActiveServer(Guid) None Set an active server applicable application-wide for the service.
M SetActiveServer(Guid, Document) None Change the active server for a specific document.
M UnsetActiveServer(Document) None Unset the active server for the particular document.
M AddServer(IExternalServer) None Registers a server with its service. ExternalService
M Dispose() None Releases all resources used by the ExternalService
M GetDefaultServerId() Guid Returns the Id of the default server if one was assigned to the service. ExternalService
M GetOptions() ExternalServiceOptions A copy of the options the service was registered with. ExternalService
M GetPublicAccessKey() Guid Access key to use to execute a service. ExternalService
M GetRegisteredServerIds() IList<Guid> Returns Ids of all servers registered for the service. ExternalService
M GetServer(Guid) IExternalServer Returns the instance that provides implementation for a registered server. ExternalService
M IsRegisteredServerId(Guid) bool Checks if the Id represents a valid server that has been registered for the service. ExternalService
M RemoveServer(Guid) None Removes/unregisters a server from the service. ExternalService
Name Return Type Description Inherited From
P Description string The description for the service ExternalService
P IsSerializable bool Indicates whether executions of the service requires serialization in documents or not. ExternalService
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. ExternalService
P Name string The name of the service ExternalService
P NumberOfServers int Indicates the number of servers currently registered with the service. ExternalService
P ServiceId ExternalServiceId The Id of the service ExternalService
P VendorId string The vendor who provided the service ExternalService