Click or drag to resize
Service Class
Defines a service which provides access to API data.
Inheritance Hierarchy
SystemObject
  Bloomberglp.BlpapiService

Namespace:  Bloomberglp.Blpapi
Assembly:  Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.11.1.1
Syntax
public abstract class Service

The Service type exposes the following members.

Constructors
  NameDescription
Protected methodService
Initializes a new instance of the Service class
Top
Properties
  NameDescription
Public propertyAuthorizationServiceName
Gets the name of the Service which must be used in order to authorize access to restricted operations on this Service.
Public propertyEventDefinitions
Gets an enumerable collection of all event definitions in this service.
Public propertyName
Gets a string which contains the name of this Service.
Public propertyNumEventDefinitions
Gets the number of unsolicited events defined by this Service.
Public propertyNumOperations
Gets the number of Operations defined by this Service.
Public propertyOperations
Gets the enumerable collection of all Operations.
Top
Methods
  NameDescription
Public methodCreateAdminEvent
Create an Admin Event suitable for publishing to this Service. Use an EventFormatter to add Messages to the Event and set fields.
Public methodCreateAuthorizationRequest
Returns an empty Request object to be used for authorization.
Public methodCreatePublishEvent
Create an {@link Event} suitable for publishing to this Service. Use an {@link EventFormatter} to add Messages to the Event and set fields.
Public methodCreateRequest
Returns an empty Request object for the specified operation.
Public methodCreateResponseEvent
Create a response Event to answer the request. Use an EventFormatter to add a Message to the Event and set fields.
Public methodGetEventDefinition(Int32)
Gets the SchemaElementDefinition of the event of this Service at the specified index.
Public methodGetEventDefinition(String)
Gets the SchemaElementDefinition of the event of this Service with the specified name.
Public methodGetEventDefinition(Name)
Gets the SchemaElementDefinition of the event of this Service with the specified name.
Public methodGetOperation(Int32)
Gets the Operation of this Service at the specified index.
Public methodGetOperation(String)
Gets the Operation of this Service having the specified name.
Public methodGetOperation(Name)
Gets the Operation of this Service having the specified name.
Public methodPrint(Stream)
Prints the schema of this service to Stream.
Public methodPrint(TextWriter)
Prints the schema of this service to TextWriter.
Top
Remarks

A Service object is obtained from a Session and contains the Operations (each of which contains its own schema) and the schema for Events which this Service may produce. A Service object is also used to create Request objects used with a Session to issue requests.

All data delivered via the API is associated with a service. Before accessing data using the API using either request-reply or subscription, the appropriate Service must be opened and, if necessary, authorized.

Thread Safety
Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
See Also