| Service Class |
Defines a service which provides access to API data.
Inheritance HierarchyNamespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.12.5.1
SyntaxThe Service type exposes the following members.
Constructors
Properties| Name | Description | |
|---|---|---|
 | AuthorizationServiceName | Gets the name of the Service which must be used in order to authorize
access to restricted operations on this Service.
|
| EventDefinitions |
Gets an enumerable collection of all event definitions in this service.
|
| Name |
Gets a string which contains the name of this Service.
|
| NumEventDefinitions | Gets the number of unsolicited events defined by this Service.
|
| NumOperations |
Gets the number of Operations defined by this Service.
|
| Operations | Gets the enumerable collection of all Operations.
|
Methods| Name | Description | |
|---|---|---|
 | CreateAdminEvent |
Create an Admin Event suitable for publishing to this Service.
Use an EventFormatter to add Messages to the Event and set fields.
|
| CreateAuthorizationRequest | Returns an empty Request object to be used for authorization.
|
| CreatePublishEvent |
Create an {@link Event} suitable for publishing to this Service.
Use an {@link EventFormatter} to add Messages to the Event
and set fields.
|
| CreateRequest | Returns an empty Request object for the specified operation.
|
| CreateResponseEvent |
Create a response Event to answer the request.
Use an EventFormatter to add a Message to the Event and set fields.
|
| GetEventDefinition(Int32) | Gets the SchemaElementDefinition of the event of this Service
at the specified index.
|
| GetEventDefinition(String) | Gets the
SchemaElementDefinition
of the event of this Service with the specified name.
|
| GetEventDefinition(Name) | Gets the
SchemaElementDefinition
of the event of this Service with the specified name.
|
| GetOperation(Int32) | Gets the Operation of this Service
at the specified index.
|
| GetOperation(String) | Gets the Operation
of this Service having the specified name.
|
| GetOperation(Name) | Gets the Operation
of this Service having the specified name.
|
| Print(Stream) | Prints the schema of this service to Stream.
|
| Print(TextWriter) | Prints the schema of this service to TextWriter.
|
RemarksA 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 SafetyStatic members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
See Also