### start()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ProviderSession.html

Starts the Session in synchronous mode and blocks until it has started or failed.

```APIDOC
## start()

### Description
Start this `Session` in synchronous mode. Blocks until the `Session` has started or failed to start. A `SESSION_STATUS` `Event` is generated before `start()` returns. A `Session` may only be started once.

### Returns
- **bool**: `True` if the `Session` started successfully, `False` otherwise.
```

--------------------------------

### Session.start()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Starts the session.

```APIDOC
## start()

### Description
Starts the session.

### Method
blpapi.Session.start()

### Parameters
None

### Response
None
```

--------------------------------

### start

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.EventDispatcher.html

Starts the event dispatching process for associated sessions.

```APIDOC
## EventDispatcher.start

### Description
Start generating callbacks for events from sessions associated with this `EventDispatcher`.

### Return type
`int`
```

--------------------------------

### ProviderSession.start()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Starts the provider session.

```APIDOC
## start()

### Description
Starts the provider session.

### Method
blpapi.ProviderSession.start()

### Parameters
None

### Response
None
```

--------------------------------

### EventDispatcher.start()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Starts the event dispatcher.

```APIDOC
## start()

### Description
Starts the event dispatcher.

### Method
blpapi.EventDispatcher.start()

### Parameters
None

### Response
None
```

--------------------------------

### Start Session with ZfpUtil for Leased Lines

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ZfpUtil.html

Use ZfpUtil to create SessionOptions for private leased lines. This operation is costly and should ideally be called once per application. After obtaining the options, set authentication and start the session.

```python
tlsOptions = blpapi.TlsOptions.createFromFiles( ... )
sessionOptions = blpapi.ZfpUtil.getZfpOptionsForLeasedLines(
    blpapi.ZfpUtil.REMOTE_8194,
    tlsOptions)

sessionOptions.setAuthenticationOptions( ... )

session = blpapi.Session(sessionOptions)
session.start()

```

--------------------------------

### startAsync()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ProviderSession.html

Starts the Session in asynchronous mode.

```APIDOC
## startAsync()

### Description
Start this `Session` in asynchronous mode. The application must monitor events for a `SESSION_STATUS` `Event` which will be generated once the `Session` has started or if it fails to start. A `Session` may only be started once.

### Returns
- **bool**: `True` if the process to start a `Session` began successfully, `False` otherwise.
```

--------------------------------

### ProviderSession.startAsync()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Starts the provider session asynchronously.

```APIDOC
## startAsync()

### Description
Starts the provider session asynchronously.

### Method
blpapi.ProviderSession.startAsync()

### Parameters
None

### Response
None
```

--------------------------------

### startAsync

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Session.html

Starts the Session in asynchronous mode. The application must monitor events for a `SESSION_STATUS` Event to determine if the session has started or failed.

```APIDOC
## startAsync

### Description
Attempt to begin the process to start this `Session` in asynchronous mode. The application must monitor events for a `SESSION_STATUS` `Event` which will be generated once the `Session` has started or if it fails to start. The `SESSION_STATUS` `Event` may be processed by the registered `eventHandler` before `startAsync()` has returned. A `Session` may only be started once.

### Returns
`True` if the process to start a `Session` began successfully, `False` otherwise.

### Return type
`bool`
```

--------------------------------

### start

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Session.html

Starts the Session in synchronous mode, blocking until the session has started or failed. A `SESSION_STATUS` Event is generated before this method returns.

```APIDOC
## start

### Description
Start this `Session` in synchronous mode. This method blocks until the `Session` has started or failed to start. A `SESSION_STATUS` `Event` is generated before this method returns. A `Session` may only be started once.

### Returns
`True` if the `Session` started successfully, `False` otherwise.

### Return type
`bool`
```

--------------------------------

### serverHost

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the server host option.

```APIDOC
host = session_options.serverHost()
session_options.setServerHost("localhost")
```

--------------------------------

### numStartAttempts

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the maximum number of attempts to start a session.

```APIDOC
num_attempts = session_options.numStartAttempts()
session_options.setNumStartAttempts(3)
```

--------------------------------

### blpapi.SessionOptions.authenticationOptions

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Gets the authentication options from session options.

```APIDOC
## blpapi.SessionOptions.authenticationOptions

### Description
Gets the authentication options from session options.

### Method
authenticationOptions

### Parameters
None
```

--------------------------------

### authenticationOptions

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the authentication options string for the session.

```APIDOC
auth_options = session_options.authenticationOptions()
session_options.setAuthenticationOptions("auth=user,options=request:password=mypass")
```

--------------------------------

### clientMode

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the client mode for the session.

```APIDOC
client_mode = session_options.clientMode()
session_options.setClientMode(blpapi.SessionOptions.DAPI)
```

--------------------------------

### defaultServices

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the default services string, separated by semicolons.

```APIDOC
services = session_options.defaultServices()
session_options.setDefaultServices("/service/refdata;/service/ சந்தைdata")
```

--------------------------------

### blpapi.Socks5Config.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new Socks5Config object.

```APIDOC
## blpapi.Socks5Config.__init__

### Description
Initializes a new Socks5Config object.

### Method
__init__

### Parameters
None
```

--------------------------------

### blpapi.ServiceRegistrationOptions.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new ServiceRegistrationOptions object.

```APIDOC
## blpapi.ServiceRegistrationOptions.__init__

### Description
Initializes a new ServiceRegistrationOptions object.

### Method
__init__

### Parameters
None
```

--------------------------------

### Socks5Config.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Socks5Config.html

Initializes a new Socks5Config object with the specified hostname and port for the SOCKS5 proxy.

```APIDOC
### __init__(hostname, port)

Parameters:
    
  * **hostname** (`str`) – hostname of the SOCKS5 proxy
  * **port** (`int`) – port of the SOCKS5 proxy. Must be between 1 and 65535

Creates an object that defines a SOCKS5 proxy.
```

--------------------------------

### blpapi.TopicList.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new TopicList object.

```APIDOC
## blpapi.TopicList.__init__

### Description
Initializes a new TopicList object.

### Method
__init__

### Parameters
None
```

--------------------------------

### sessionName

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the session name.

```APIDOC
session_name = session_options.sessionName()
session_options.setSessionName("MySession")
```

--------------------------------

### blpapi.ProviderSession.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new ProviderSession object.

```APIDOC
## blpapi.ProviderSession.__init__

### Description
Initializes a new ProviderSession object.

### Method
__init__

### Parameters
None
```

--------------------------------

### blpapi.ResolutionList.attributeAt

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Gets an attribute from the resolution list by index.

```APIDOC
## blpapi.ResolutionList.attributeAt

### Description
Gets an attribute from the resolution list by index.

### Method
attributeAt

### Parameters
None
```

--------------------------------

### blpapi.SubscriptionList.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new SubscriptionList object.

```APIDOC
## blpapi.SubscriptionList.__init__

### Description
Initializes a new SubscriptionList object.

### Method
__init__

### Parameters
None
```

--------------------------------

### blpapi.SessionOptions.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new SessionOptions object.

```APIDOC
## blpapi.SessionOptions.__init__

### Description
Initializes a new SessionOptions object.

### Method
__init__

### Parameters
None
```

--------------------------------

### blpapi.ResolutionList.attribute

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Gets an attribute from the resolution list by name.

```APIDOC
## blpapi.ResolutionList.attribute

### Description
Gets an attribute from the resolution list by name.

### Method
attribute

### Parameters
None
```

--------------------------------

### serverPort

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the server port option.

```APIDOC
port = session_options.serverPort()
session_options.setServerPort(8194)
```

--------------------------------

### blpapi.Session.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new Session object.

```APIDOC
## blpapi.Session.__init__

### Description
Initializes a new Session object.

### Method
__init__

### Parameters
None
```

--------------------------------

### __init__()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ResolutionList.html

Initializes an empty ResolutionList object.

```APIDOC
def __init__()
```

--------------------------------

### serverAddresses

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get an iterator over the configured server addresses.

```APIDOC
for server_addr in session_options.serverAddresses():
    print(server_addr)
```

--------------------------------

### __init__()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SubscriptionList.html

Creates an empty SubscriptionList object.

```APIDOC
## Method: __init__()

### Description
Create an empty `SubscriptionList`.

### Returns
- `SubscriptionList`: An empty SubscriptionList object.
```

--------------------------------

### blpapi.NotFoundException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new NotFoundException object.

```APIDOC
## blpapi.NotFoundException.__init__

### Description
Initializes a new NotFoundException object.

### Method
__init__

### Parameters
None
```

--------------------------------

### numServerAddresses

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get the number of server addresses configured.

```APIDOC
num_addresses = session_options.numServerAddresses()
```

--------------------------------

### defaultSubscriptionService

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the default subscription service.

```APIDOC
sub_service = session_options.defaultSubscriptionService()
session_options.setDefaultSubscriptionService("/service/ சந்தைdata")
```

--------------------------------

### connectTimeout

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the connection timeout in milliseconds.

```APIDOC
timeout = session_options.connectTimeout()
session_options.setConnectTimeout(5000)
```

--------------------------------

### blpapi.EventDispatcher.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new EventDispatcher object.

```APIDOC
## blpapi.EventDispatcher.__init__

### Description
Initializes a new EventDispatcher object.

### Method
__init__

### Parameters
None
```

--------------------------------

### Create and Populate Element

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Element.html

Demonstrates creating an Element from a request and populating its fields, including nested structures and arrays.

```python
exampleRequest = service.createRequest("ExampleRequest")
exampleElement = exampleRequest.asElement()

complexElement = exampleElement.getElement("complexElement")
complexElement.getElement("nullElement")

arrayElement = exampleElement.getElement("arrayElement")
array = arrayElement.appendElement()
arrayValue.setElement("id", 2)
endpointElement = arrayValue.getElement("endpoint")
endpointElement.setElement("address", "127.0.0.1:8000")

exampleElement.setElement("valueElement", "Sample value")

```

--------------------------------

### blpapi.Service.authorizationServiceName

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Gets the authorization service name for the given service.

```APIDOC
## blpapi.Service.authorizationServiceName

### Description
Gets the authorization service name for the given service.

### Method
authorizationServiceName

### Parameters
None
```

--------------------------------

### blpapi.ResolutionList.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new ResolutionList object.

```APIDOC
## blpapi.ResolutionList.__init__

### Description
Initializes a new ResolutionList object.

### Method
__init__

### Parameters
None
```

--------------------------------

### blpapi.SessionOptions.applicationIdentityKey

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Gets the application identity key from session options.

```APIDOC
## blpapi.SessionOptions.applicationIdentityKey

### Description
Gets the application identity key from session options.

### Method
applicationIdentityKey

### Parameters
None
```

--------------------------------

### __init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.FieldNotFoundException.html

Initializes a new instance of the FieldNotFoundException class.

```APIDOC
__init__(description, errorCode)
    Create a blpapi exception 

    Parameters:
        description (str): Description of the error
        errorCode (Optional[int]): Code corresponding to the error
```

--------------------------------

### serviceDownloadTimeout

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the service download timeout in milliseconds.

```APIDOC
download_timeout = session_options.serviceDownloadTimeout()
session_options.setServiceDownloadTimeout(30000)
```

--------------------------------

### UnsupportedOperationException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.UnsupportedOperationException.html

Constructor for the UnsupportedOperationException class.

```APIDOC
## __init__(self, description, errorCode)

### Description
Create a blpapi exception.

### Parameters
* **description** (str) - Description of the error
* **errorCode** (Optional[int]) - Code corresponding to the error
```

--------------------------------

### serviceCheckTimeout

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the service check timeout in milliseconds.

```APIDOC
check_timeout = session_options.serviceCheckTimeout()
session_options.setServiceCheckTimeout(15000)
```

--------------------------------

### AuthOptions.createWithApp()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthOptions.html

Creates an AuthOptions instance for Application Mode using a specified application name.

```APIDOC
## createWithApp()

### Description
Create an `AuthOptions` instance for Application Mode.

### Parameters
* **appName** (`str`) - app name used for Application Mode.

### Returns
* `AuthOptions` - Specifies Application Mode.
The behavior is undefined when `appName` is `None` or `""`.
```

--------------------------------

### keepAliveEnabled

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set whether the keep-alive mechanism is enabled.

```APIDOC
keep_alive = session_options.keepAliveEnabled()
session_options.setKeepAliveEnabled(True)
```

--------------------------------

### TlsOptions.createFromFiles

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.TlsOptions.html

Creates a TlsOptions instance using DER encoded client credentials and trusted certificates from specified files.

```APIDOC
## TlsOptions.createFromFiles()

### Description
Creates a `TlsOptions` using a DER encoded client credentials in PKCS#12 format and DER encoded trust material in PKCS#7 format from the specified files.

### Parameters
* **clientCredentialsFilename** (`str`) – Path to the file with the client credentials
* **clientCredentialsPassword** (`str`) – Password for the credentials
* **trustedCertificatesFilename** (`str`) – Path to the file with the trusted certificates

### Returns
`TlsOptions`
```

--------------------------------

### blpapi.EventQueue.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new EventQueue object.

```APIDOC
## blpapi.EventQueue.__init__

### Description
Initializes a new EventQueue object.

### Method
__init__

### Parameters
None
```

--------------------------------

### defaultTopicPrefix

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the default topic prefix for subscriptions.

```APIDOC
topic_prefix = session_options.defaultTopicPrefix()
session_options.setDefaultTopicPrefix("my_prefix")
```

--------------------------------

### openServiceAsync

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Session.html

Asynchronously begins the process of opening a service. Returns immediately.

```APIDOC
## openServiceAsync(_serviceName_ , _correlationId =None_)

### Description
Begin the process to open the service identified by the specified `serviceName` and return immediately. The optional specified `correlationId` is used to track `Event`s generated as a result of this call.
The `serviceName` must contain a fully qualified service name. That is, it must be of the form `//<namespace>/<service-name>`.
The application must monitor events for a `SERVICE_STATUS` `Event` which will be generated once the service has been successfully opened or the opening has failed.

### Parameters
* **serviceName** (`str`) – Name of the service
* **correlationId** (`Optional`[`CorrelationId`]) – Correlation id to associate with events generated as a result of this call

### Returns
* `CorrelationId` – The correlation id used to identify the Events generated as a result of this call.
```

--------------------------------

### SessionOptions Initialization

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Create a SessionOptions instance with all options set to their default values.

```APIDOC
session_options = blpapi.SessionOptions()
```

--------------------------------

### Service.numEventDefinitions()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Service.html

Gets the number of unsolicited event definitions for this service.

```APIDOC
## Service.numEventDefinitions()

### Description
Returns the number of unsolicited events defined by this `Service`.

### Return Type
`int`
```

--------------------------------

### blpapi.Exception.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new Exception object.

```APIDOC
## blpapi.Exception.__init__

### Description
Initializes a new Exception object.

### Method
__init__

### Parameters
None
```

--------------------------------

### setNumStartAttempts

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Sets the number of start attempts. This method is available for blpapi.SessionOptions.

```APIDOC
## setNumStartAttempts()

### Description
Sets the number of start attempts.

### Method
(Available on blpapi.SessionOptions)

```

--------------------------------

### slowConsumerWarningHiWaterMark

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get the high water mark for slow consumer warnings.

```APIDOC
## slowConsumerWarningHiWaterMark()

### Return type
`float`

### Returns
The fraction of `maxEventQueueSize()` at which “slow consumer” event will be generated.
```

--------------------------------

### AuthOptions.createWithUser()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthOptions.html

Creates an AuthOptions instance for User Mode, supporting Operating System Login, Active Directory, or Email.

```APIDOC
## createWithUser()

### Description
Creates an `AuthOptions` instance for User Mode with the Operating System Login (Domain/User), Active Directory, or Email.

### Parameters
* **user** (`AuthUser`) - user-specific authorization option.

### Returns
* `AuthOptions` - Specifies User Mode with the Operating System Login (Domain/User), Active Directory, or Email.
The behavior is undefined when `user` was created with `AuthUser.createWithManualOptions()` or is `None`.
```

--------------------------------

### blpapi.UnknownErrorException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new UnknownErrorException object.

```APIDOC
## blpapi.UnknownErrorException.__init__

### Description
Initializes a new UnknownErrorException object.

### Method
__init__

### Parameters
None
```

--------------------------------

### maxPendingRequests

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the maximum number of pending requests allowed.

```APIDOC
max_requests = session_options.maxPendingRequests()
session_options.setMaxPendingRequests(50)
```

--------------------------------

### flushPublishedEventsTimeout

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the timeout in milliseconds for flushing published events.

```APIDOC
flush_timeout = session_options.flushPublishedEventsTimeout()
session_options.setFlushPublishedEventsTimeout(3000)
```

--------------------------------

### blpapi.SubscriptionPreprocessError.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new SubscriptionPreprocessError object.

```APIDOC
## blpapi.SubscriptionPreprocessError.__init__

### Description
Initializes a new SubscriptionPreprocessError object.

### Method
__init__

### Parameters
None
```

--------------------------------

### defaultKeepAliveResponseTimeout

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the time in milliseconds to wait for a keep-alive response.

```APIDOC
response_timeout = session_options.defaultKeepAliveResponseTimeout()
session_options.setDefaultKeepAliveResponseTimeout(10000)
```

--------------------------------

### AuthOptions.createWithUserAndApp()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthOptions.html

Creates an AuthOptions instance for combined User and Application Mode.

```APIDOC
## createWithUserAndApp()

### Description
Create an `AuthOptions` instance for User and Application Mode.

### Parameters
* **user** (`AuthUser`) - user-specific authorization option.
* **appName** (`str`) - app name used for Application Mode.

### Returns
* `AuthOptions` - an `AuthOptions` that contains the authorization option for the User+Application authorization mode.
The behavior is undefined when `appName` is `None` or `""`.
```

--------------------------------

### bandwidthSaveModeDisabled

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set whether bandwidth saving measures are disabled.

```APIDOC
bw_save_disabled = session_options.bandwidthSaveModeDisabled()
session_options.setBandwidthSaveModeDisabled(True)
```

--------------------------------

### AuthOptions.createWithToken()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthOptions.html

Creates an AuthOptions instance for Manual Token Mode using a provided token.

```APIDOC
## createWithToken()

### Description
Create an `AuthOptions` instance for Manual Token Mode.

### Parameters
* **token** (`str`) - token to use for Manual Token Mode.

### Returns
* `AuthOptions` - Specifies Manual Token Mode.
The behavior is undefined when `token` is `None` or `""`.
```

--------------------------------

### blpapi.FieldNotFoundException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new FieldNotFoundException object.

```APIDOC
## blpapi.FieldNotFoundException.__init__

### Description
Initializes a new FieldNotFoundException object.

### Method
__init__

### Parameters
None
```

--------------------------------

### autoRestartOnDisconnection

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set whether the session should automatically restart on disconnection.

```APIDOC
auto_restart = session_options.autoRestartOnDisconnection()
session_options.setAutoRestartOnDisconnection(True)
```

--------------------------------

### Service.numOperations()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Service.html

Gets the total number of operations defined within this service.

```APIDOC
## Service.numOperations()

### Description
Returns the number of `Operation`s defined by this `Service`.

### Return Type
`int`
```

--------------------------------

### setClientMode

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Set how to connect to the API. The default is AUTO.

```APIDOC
## setClientMode(clientMode)

### Description
Set how to connect to the API. The default is `AUTO` which will try to connect to the desktop API but fall back to the server API if the desktop is not available. `DAPI` always connects to the desktop API and will fail if it is not available. `SAPI` always connects to the server API and will fail if it is not available.

### Parameters
* **clientMode** (`int`) – The client mode

### Return type
`None`
```

--------------------------------

### setNumStartAttempts

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Sets the maximum number of attempts to start a session by connecting to a server.

```APIDOC
## setNumStartAttempts

### Description
Set the maximum number of attempts to start a session by connecting a server.

### Return type
`None`
```

--------------------------------

### blpapi.FixedOffset.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new FixedOffset object.

```APIDOC
## blpapi.FixedOffset.__init__

### Description
Initializes a new FixedOffset object.

### Method
__init__

### Parameters
None
```

--------------------------------

### slowConsumerWarningLoWaterMark

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get the low water mark for slow consumer cleared events.

```APIDOC
## slowConsumerWarningLoWaterMark()

### Return type
`float`

### Returns
The fraction of `maxEventQueueSize()` at which “slow consumer cleared” event will be generated.
```

--------------------------------

### maxEventQueueSize

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the maximum size of the event queue for undelivered events.

```APIDOC
max_queue_size = session_options.maxEventQueueSize()
session_options.setMaxEventQueueSize(1000)
```

--------------------------------

### UnknownErrorException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.UnknownErrorException.html

Constructor for the UnknownErrorException class. Initializes a new instance of the exception with a description and an error code.

```APIDOC
## UnknownErrorException.__init__(description, errorCode)

### Description
Create a blpapi exception

### Parameters
#### Parameters
- **description** (str) – Description of the error
- **errorCode** (Optional[int]) – Code corresponding to the error
```

--------------------------------

### defaultKeepAliveInactivityTime

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the inactivity time in milliseconds before a keep-alive probe is sent.

```APIDOC
inactivity_time = session_options.defaultKeepAliveInactivityTime()
session_options.setDefaultKeepAliveInactivityTime(30000)
```

--------------------------------

### Constructing an Event with EventFormatter

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.EventFormatter.html

Demonstrates how to build a response event by appending elements and values using EventFormatter methods.

```python
response = service.createResponseEvent(CorrelationId(0))
ef = EventFormatter(response)
ef.appendResponse("SampleOperation")

ef.pushElement("complexElement")
ef.setElementNull("nullElement")
ef.popElement()
ef.pushElement("scalarArray")
ef.appendValue("value1")
ef.appendValue("value2")
ef.popElement()
ef.pushElement("complexArray")
ef.appendElement()
ef.setElement("value", 1)
ef.setElement("message", "msg")
ef.popElement()
ef.popElement()
ef.setElement("valueElement", "value")
ef.setElementNull("nullValueElement")
```

--------------------------------

### Format Element using fromPy()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Element.html

Shows how to use the `fromPy()` method to format an Element from a Python dictionary, mirroring the structure of the Element.

```python
exampleRequest = service.createRequest("ExampleRequest")
exampleElement = exampleRequest.asElement()
exampleElementAsDict = {
    "complexElement": {
        "nullElement": {}
    },
    "arrayElement": [
        {
            "id": 2,
            "endpoint": {
                "address": "127.0.0.1:8000"
            }
        }
    ],
    "valueElement": "Sample value",
    "nullValueElement": None
}
exampleElement.fromPy(exampleElementAsDict)

```

--------------------------------

### allowMultipleCorrelatorsPerMsg

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set the option to allow multiple correlators per message.

```APIDOC
allow_multiple = session_options.allowMultipleCorrelatorsPerMsg()
session_options.setAllowMultipleCorrelatorsPerMsg(True)
```

--------------------------------

### Element Creation and Manipulation

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Element.html

Demonstrates how to create and populate an Element object, including nested structures, arrays, and scalar values. It also shows how to convert Python objects to Elements using `fromPy()` and back using `toPy()`.

```APIDOC
## Element Creation and Population

### Description
This section illustrates the creation of an `Element` object and its population with various data types, including nested elements, arrays, and scalar values. It also demonstrates the utility of `fromPy()` for converting Python data structures into `Element` objects and `toPy()` for the reverse conversion.

### Code Examples

**Creating and Populating an Element:**
```python
exampleRequest = service.createRequest("ExampleRequest")
exampleElement = exampleRequest.asElement()

complexElement = exampleElement.getElement("complexElement")
complexElement.getElement("nullElement")

arrayElement = exampleElement.getElement("arrayElement")
array = arrayElement.appendElement()
arrayValue.setElement("id", 2)
endpointElement = arrayValue.getElement("endpoint")
endpointElement.setElement("address", "127.0.0.1:8000")

exampleElement.setElement("valueElement", "Sample value")
```

**Using `fromPy()` to format an Element:**
```python
exampleRequest = service.createRequest("ExampleRequest")
exampleElement = exampleRequest.asElement()
exampleElementAsDict = {
    "complexElement": {
        "nullElement": {}
    },
    "arrayElement": [
        {
            "id": 2,
            "endpoint": {
                "address": "127.0.0.1:8000"
            }
        }
    ],
    "valueElement": "Sample value",
    "nullValueElement": None
}
exampleElement.fromPy(exampleElementAsDict)
```

**Using `fromPy()` with Sequences and Scalars:**
```python
arrayElementAsList = [{
        "id": 2,
        "endpoint": { "address": "127.0.0.1:8000" }
    }]
arrayElement = exampleElement.getElement("arrayElement")
arrayElement.fromPy(arrayElementAsList)

exampleElement.getElement("valueElement").fromPy("Sample value")
```

**Verifying `fromPy()` with `toPy()`:**
```python
exampleElement.fromPy(exampleElementAsDict)
print(exampleElementAsDict == exampleElement.toPy()) # True
```
```

--------------------------------

### recordSubscriptionDataReceiveTimes

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SessionOptions.html

Get or set whether to record receive times for subscription data messages.

```APIDOC
record_times = session_options.recordSubscriptionDataReceiveTimes()
session_options.setRecordSubscriptionDataReceiveTimes(True)
```

--------------------------------

### Message timeReceived

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Message.html

Gets the time when the message was received by the SDK, with optional timezone information.

```APIDOC
## Message.timeReceived(_tzinfo= <blpapi.datetime.FixedOffset object>_)

### Description
Get the time when the message was received by the SDK. The resulting datetime will be represented using the specified `tzinfo` value, and will be measured using a high-resolution clock internal to the SDK.

### Parameters
* **tzinfo** (`tzinfo`) - Timezone info

### Returns
`datetime.datetime` or `datetime.date` or `datetime.time` - Time when the message was received by the SDK.

### Raises
**ValueError** – If this information was not recorded for this message. See `SessionOptions.recordSubscriptionDataReceiveTimes()` for information on configuring this recording.
```

--------------------------------

### createTopicsAsync(_topicList_, _resolveMode =0_, _identity =None_)

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ProviderSession.html

Asynchronously creates topics in the specified topicList and updates it with the resolution results.

```APIDOC
## createTopicsAsync(_topicList_, _resolveMode =0_, _identity =None_)

### Description
Create the topics in the specified `topicList`. If service needs to be registered, `identity` should be supplied. Once a call to this function returns, each entry in the `topicList` will have been updated with a new topic creation status.

### Parameters
* **topicList** – List of topics to create
* **resolveMode** – Mode to use for topic resolution
* **identity** – Identity to use for authorization

### Notes
Before `createTopics()` returns one or more `RESOLUTION_STATUS` events, zero or more `SERVICE_STATUS` events and one or more `TOPIC_STATUS` events are generated. If this is an asynchronous `ProviderSession` then these `Event`s may be processed by the registered `eventHandler` before `createTopics()` has returned. When `identity` is not provided, the session identity will be used if it has been authorized.
```

--------------------------------

### ServiceRegistrationOptions

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ServiceRegistrationOptions.html

Represents options for registering a service. This class provides methods to set and get various registration parameters.

```APIDOC
## Class: blpapi.ServiceRegistrationOptions

### Description
Provides options for registering a service. Users can configure parts to register, service priority, and group ID.

### Methods

*   `__init__()`: Constructor for ServiceRegistrationOptions.
*   `addActiveSubServiceCodeRange(start, end)`: Adds a range of sub-service codes to be registered.
*   `destroy()`: Destroys the ServiceRegistrationOptions object.
*   `getGroupId()`: Returns the group ID associated with this registration.
*   `getPartsToRegister()`: Returns the parts of the service that are registered.
*   `getServicePriority()`: Returns the priority of the service registration.
*   `isValid()`: Checks if the ServiceRegistrationOptions object is valid.
*   `removeAllActiveSubServiceCodeRanges()`: Removes all active sub-service code ranges.
*   `setGroupId(groupId)`: Sets the group ID for this registration.
*   `setPartsToRegister(parts)`: Sets the parts of the service to register.
*   `setServicePriority(priority)`: Sets the priority for the service registration.

### Constants

*   `PART_DEFAULT`: Default parts to register.
*   `PART_OPERATIONS`: Register service operations.
*   `PART_PUBLISHER_RESOLUTION`: Register publisher resolution information.
*   `PART_PUBLISHING`: Register publishing information.
*   `PART_SUBSCRIBER_RESOLUTION`: Register subscriber resolution information.
*   `PRIORITY_HIGH`: High priority for service registration.
*   `PRIORITY_LOW`: Low priority for service registration.
*   `PRIORITY_MEDIUM`: Medium priority for service registration.
```

--------------------------------

### Setting Element Values

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Element.html

Demonstrates how to set values for scalar, array, and complex elements.

```APIDOC
## Setting Scalar Element Values

### Description
Set the value of a scalar element.

### Method
`setValue(value)`

### Example
```python
value = 5
s.setValue(value)
```

## Appending to Array Element Values

### Description
Append a value to an array element.

### Method
`appendValue(value)`

### Example
```python
value = 5
a.appendValue(value)
```

## Setting Complex Element Values (Sequences and Choices)

### Description
Set the value of a sub-element within a complex element (sequence or choice) by its name.

### Method
`setElement(name, value)`

### Example
```python
from blpapi import Name
name_city = Name("city") # Ideally defined once
address.setElement(name_city, "New York")
```
```

--------------------------------

### Get Event Type

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Event.html

Retrieves the integer type of the event. Use this method to programmatically determine the nature of the event.

```python
event.eventType()
```

--------------------------------

### openServiceAsync

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AbstractSession.html

Asynchronously initiates the process to open the specified service. Returns immediately, and a correlation ID is provided to track events.

```APIDOC
## openServiceAsync(_serviceName_ , _correlationId =None_)

### Description
Begin the process to open the service and return immediately.

### Parameters
* **serviceName** (`str`) – Name of the service
* **correlationId** (`Optional`[`CorrelationId`]) – Correlation id to associate with events generated as a result of this call

### Returns
The correlation id used to identify the Events generated as a result of this call

### Return type
CorrelationId
Begin the process to open the service identified by the specified `serviceName` and return immediately. The optional specified `correlationId` is used to track `Event`s generated as a result of this call.
The `serviceName` must contain a fully qualified service name. That is, it must be of the form `//<namespace>/<service-name>`.
The application must monitor events for a `SERVICE_STATUS` `Event` which will be generated once the service has been successfully opened or the opening has failed.
```

--------------------------------

### blpapi.EventFormatter.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new EventFormatter object.

```APIDOC
## blpapi.EventFormatter.__init__

### Description
Initializes a new EventFormatter object.

### Method
__init__

### Parameters
None
```

--------------------------------

### getEventDefinition(_nameOrIndex_)

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Service.html

Get the definition of a specified event. Returns an object describing the element identified by the specified `nameOrIndex`. Note: Please use `Name` over `str` where possible for `nameOrIndex`. `Name` objects should be initialized once and then reused in order to minimize lookup cost.

```APIDOC
## getEventDefinition(_nameOrIndex_)

### Description
Get the definition of a specified event.

### Parameters
- **nameOrIndex** (`Union`[`Name`, `int`]) – Name or index of the event

### Returns
- `SchemaElementDefinition`: Object describing the element identified by the specified `nameOrIndex`.

### Raises
- **NotFoundException**: If `nameOrIndex` is a string and `hasEventDefinition(nameOrIndex) != True`
- **IndexOutOfRangeException**: If `nameOrIndex` is an integer and `nameOrIndex >= numEventDefinitions()`

### Note
**Please use** `Name` **over** `str` **where possible for** `nameOrIndex`. `Name` **objects should be initialized once and then reused** in order to minimize lookup cost.
```

--------------------------------

### SubscriptionPreprocessError Constructor

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.SubscriptionPreprocessError.html

Initializes a new instance of the SubscriptionPreprocessError class.

```APIDOC
## Method: __init__

### Description
Initializes a new instance of the `SubscriptionPreprocessError` class.

### Parameters
- **_correlationId_**: Identifier for the correlation ID associated with the subscription.
- **_subscriptionString_**: The subscription string that caused the error.
- **_errorCode_**: An integer representing the specific error code.
- **_description_**: A string providing a detailed description of the error.
```

--------------------------------

### authorizationServiceName()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Service.html

Get the authorization service name. Returns the name of the Service which must be used in order to authorize access to restricted operations on this Service. If no authorization is required to access operations on this service an empty string is returned. Authorization services never require authorization to use.

```APIDOC
## authorizationServiceName()

### Description
Get the authorization service name.

### Returns
- `str`: The name of the `Service` which must be used in order to authorize access to restricted operations on this `Service`. If no authorization is required to access operations on this service an empty string is returned. Authorization services never require authorization to use.
```

--------------------------------

### TlsOptions.createFromBlobs

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.TlsOptions.html

Creates a TlsOptions instance using DER encoded client credentials and trusted certificates provided as raw data blobs.

```APIDOC
## TlsOptions.createFromBlobs()

### Description
Creates a `TlsOptions` using a DER encoded client credentials in PKCS#12 format and DER encoded trust material in PKCS#7 format from the given raw data.

### Parameters
* **clientCredentials** (`Union`[`bytes`, `bytearray`]) – Blob with the client credentials
* **clientCredentialsPassword** (`str`) – Password for the credentials
* **trustedCertificates** (`Union`[`bytes`, `bytearray`]) – Blob with the trusted certificates

### Returns
`TlsOptions`
```

--------------------------------

### blpapi.SessionOptions Methods

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Methods for configuring session options.

```APIDOC
recordSubscriptionDataReceiveTimes()
removeServerAddress()
```

--------------------------------

### createTopic

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.test.createTopic.html

Creates a valid blpapi.Topic for testing purposes, typically used when mocking provider sessions.

```APIDOC
## createTopic()

### Description
Creates a valid `blpapi.Topic` with the specified `service` to support testing publishers. The expected use case is to support returning a custom `blpapi.Topic` while mocking `blpapi.ProviderSession.getTopic()` methods.

### Parameters

* **service** (`Service`) – The `blpapi.Service` to which the returned `blpapi.Topic` will belong.
* **isActive** (`bool`) – Optional. Specifies whether the returned `blpapi.Topic` is active.

### Return type

`Topic`

### Returns

A valid `blpapi.Topic` with the specified `service`.
```

--------------------------------

### blpapi.IndexOutOfRangeException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new IndexOutOfRangeException object.

```APIDOC
## blpapi.IndexOutOfRangeException.__init__

### Description
Initializes a new IndexOutOfRangeException object.

### Method
__init__

### Parameters
None
```

--------------------------------

### Formatting an Event using fromPy()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.EventFormatter.html

Shows how to format an event using the fromPy() method with a Python dictionary representation of the event structure.

```python
response = service.createResponseEvent(CorrelationId(0))
ef = EventFormatter(response)
ef.appendResponse("SampleOperation")
sampleResponseAsDict = {
    "complexElement": {
        "nullElement": {
        }
    },
    "scalarArray": [
        "value1", "value2"
    ],
    "complexArray": [
        {
            "value": 1
            "message": "msg"
        }
    ],
    "valueElement": "value",
    "nullValueElement": None
}
ef.fromPy(sampleResponseAsDict)
```

--------------------------------

### Convert Element back to Python object with toPy()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Element.html

Demonstrates converting an Element, previously formatted with `fromPy()`, back into an equivalent Python object using `toPy()` and verifying equality.

```python
exampleElement.fromPy(exampleElementAsDict)
print(exampleElementAsDict == exampleElement.toPy()) # True

```

--------------------------------

### blpapi.test.MessageProperties.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Initializes a new MessageProperties object in the blpapi.test module.

```APIDOC
## blpapi.test.MessageProperties.__init__

### Description
Initializes a new MessageProperties object in the blpapi.test module.

### Method
__init__

### Parameters
None
```

--------------------------------

### TlsOptions

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Provides options for configuring TLS/SSL connections.

```APIDOC
## TlsOptions

### Description
Provides options for configuring TLS/SSL connections.

### Class
blpapi.TlsOptions
```

--------------------------------

### openService

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AbstractSession.html

Opens the specified service and blocks until it is successfully opened or fails. The service name must be fully qualified.

```APIDOC
## openService(_serviceName_)

### Description
Open the service identified by the specified `serviceName`.

### Parameters
**serviceName** (`str`) – Name of the service

### Return type
`bool`

### Returns
`True` if the service is opened successfully, `False` otherwise.
Attempt to open the service identified by the specified `serviceName` and block until the service is either opened successfully or has failed to be opened. Return `True` if the service is opened successfully and `False` if the service cannot be successfully opened.
The `serviceName` must contain a fully qualified service name. That is, it must be of the form `//<namespace>/<service-name>`.
Before `openService()` returns a `SERVICE_STATUS` `Event` is generated. If this is an asynchronous Session then this `Event` may be processed by the registered `eventHandler` before `openService()` has returned.
```

--------------------------------

### EventQueue.__init__()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.EventQueue.html

Constructs an empty EventQueue that can be passed to sendRequest() and sendAuthorizationRequest() methods.

```APIDOC
## EventQueue.__init__()

### Description
Construct an empty `EventQueue` which can be passed to `sendRequest()` and `sendAuthorizationRequest()` methods.

### Method
`__init__()`
```

--------------------------------

### ZfpUtil

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/genindex.html

Utility class for ZFP (Zoned File Processing).

```APIDOC
## ZfpUtil

### Description
Utility class for ZFP (Zoned File Processing).

### Class
blpapi.ZfpUtil
```

--------------------------------

### AuthUser.createWithLogonName

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthUser.html

Creates an AuthUser instance configured for Operating System Login (Domain/User) authorization mode (OS_LOGON).

```APIDOC
## createWithLogonName

### Description
Creates an `AuthUser` instance configured for Operating System Login (Domain/User) authorization mode (OS_LOGON).

### Return Type
`AuthUser`

### Returns
Configured for Operating System Login (Domain/User) mode.
```

--------------------------------

### description()

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.Service.html

Returns a human-readable description of this service.

```APIDOC
## description()

### Description
Returns a human-readable description of this service.

### Returns
- `str`: Human-readable description of this service.
```

--------------------------------

### AuthUser.createWithActiveDirectoryProperty

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthUser.html

Creates an AuthUser instance configured for Active Directory authorization mode (DIRECTORY_SERVICE).

```APIDOC
## createWithActiveDirectoryProperty

### Description
Creates an `AuthUser` instance configured for Active Directory authorization mode (DIRECTORY_SERVICE).

### Parameters
#### Path Parameters
- **propertyName** (str) - Required - Active Directory property.

### Return Type
`AuthUser`

### Returns
Configured for Active Directory (DIRECTORY_SERVICE) authorization mode. The behavior is undefined when `propertyName` is `""` or `None`.
```

--------------------------------

### createTopics(_topicList_, _resolveMode =0_, _identity =None_)

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ProviderSession.html

Creates topics in the specified topicList and updates it with the resolution results.

```APIDOC
## createTopics(_topicList_, _resolveMode =0_, _identity =None_)

### Description
Create the topics in the specified `topicList`. If service needs to be registered, `identity` should be supplied. Once a call to this function returns, each entry in the `topicList` will have been updated with a new topic creation status.

### Parameters
* **topicList** – List of topics to create
* **resolveMode** – Mode to use for topic resolution
* **identity** – Identity to use for authorization

### Notes
Before `createTopics()` returns one or more `RESOLUTION_STATUS` events, zero or more `SERVICE_STATUS` events and one or more `TOPIC_STATUS` events are generated. If this is an asynchronous `ProviderSession` then these `Event`s may be processed by the registered `eventHandler` before `createTopics()` has returned. When `identity` is not provided, the session identity will be used if it has been authorized.
```

--------------------------------

### blpapi.InvalidStateException.__init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.InvalidStateException.html

Initializes a new instance of the InvalidStateException class.

```APIDOC
## blpapi.InvalidStateException.__init__

### Description
Create a blpapi exception.

### Method Signature
`__init__(description, errorCode)`

### Parameters
* **description** (`str`) - Description of the error
* **errorCode** (`Optional[int]`) - Code corresponding to the error
```

--------------------------------

### AuthUser.createWithManualOptions

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.AuthUser.html

Creates an AuthUser instance configured for manual authorization.

```APIDOC
## createWithManualOptions

### Description
Creates an `AuthUser` instance configured for manual authorization.

### Parameters
#### Path Parameters
- **userId** (str) - Required - user id.
- **ipAddress** (str) - Required - IP address.

### Return Type
`AuthUser`

### Returns
Configured for manual authorization. The behavior is undefined when either `userId` or `ipAddress` is `""` or `None`.
```

--------------------------------

### __init__

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.EventFormatter.html

Creates an EventFormatter to create messages in the specified event. An Event may only be referenced by one EventFormatter at any time.

```APIDOC
## __init__(_event_)

### Description
Create an `EventFormatter` to create `Message`s in the specified `event`.

### Parameters
#### Path Parameters
* **event** (Event) - Event to be formatted
An `Event` may only be referenced by one `EventFormatter` at any time. Attempting to create a second `EventFormatter` referencing the same `Event` will result in an exception being raised.
```

--------------------------------

### openService

Source: https://bloomberg.github.io/blpapi-docs/python/3.25.7/_autosummary/blpapi.ProviderSession.html

Opens the service identified by the specified serviceName. Blocks until the service is opened or fails. Returns True if successful, False otherwise.

```APIDOC
## openService(_serviceName_)

### Description
Opens the service identified by the specified `serviceName`. Blocks until the service is either opened successfully or has failed to be opened. Returns `True` if the service is opened successfully and `False` if the service cannot be successfully opened. The `serviceName` must contain a fully qualified service name. That is, it must be of the form `//<namespace>/<service-name>`.

### Parameters
#### Parameters
- **serviceName** (`str`) – Name of the service

### Return type
`bool`

### Returns
`True` if the service is opened successfully, `False` otherwise.

### Notes
Before `openService()` returns a `SERVICE_STATUS` `Event` is generated. If this is an asynchronous Session then this `Event` may be processed by the registered `eventHandler` before `openService()` has returned.
```