Bot Builder Python SDK Core Package

https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest
Admin
The Bot Builder Python SDK Core Package provides foundational components for developing bots,...
Tokens:2,119
Snippets:34
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### BotFrameworkAdapterSettings

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Contains the settings used to initialize a BotFrameworkAdapter instance.

```APIDOC
## Class: BotFrameworkAdapterSettings

### Description
Contains the settings used to initialize a BotFrameworkAdapter instance.

### Parameters
* **app_id** (str) - The Microsoft App ID. Defaults to None.
* **app_password** (str) - The Microsoft App Password. Defaults to None.
* **channel_auth_tenant** (str) - The channel tenant to use in conversation. Defaults to None.
* **oauth_endpoint** (str) - The OAuth endpoint. Defaults to None.
* **open_id_metadata** (str) - The Open ID metadata. Defaults to None.
* **channel_provider** (<xref:botframework.connector.auth.ChannelProvider>) - The channel provider. Defaults to SimpleChannelProvider if one isn't specified.
* **auth_configuration** (<xref:botframework.connector.auth.AuthenticationConfiguration>) - The authentication configuration. Defaults to None.
* **credential_provider** - The credential provider. Defaults to SimpleCredentialProvider if one isn't specified.
* **app_credentials** - Allows for a custom AppCredentials. Used, for example, for CertificateAppCredentials. Defaults to None.

### Usage
```python
class BotFrameworkAdapterSettings:
    def __init__(self, app_id: str = None, app_password: str = None, channel_auth_tenant: str = None, oauth_endpoint: str = None, open_id_metadata: str = None, channel_provider: 'ChannelProvider' = None, auth_configuration: 'AuthenticationConfiguration' = None, credential_provider = None, app_credentials = None):
        pass
```
```

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

### ShowTypingMiddleware

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

When added, this middleware will send typing activities back to the user when a Message activity is received.

```APIDOC
## Class: ShowTypingMiddleware

### Description
When added, this middleware will send typing activities back to the user when a Message activity is received to let them know that the bot has received the message and is working on the response. You can specify a delay before the first typing activity is sent and then a frequency, which determines how often another typing activity is sent. Typing activities will continue to be sent until your bot sends another message back to the user.

### Usage
```python
class ShowTypingMiddleware:
    def __init__(self, delay: int = 1000, interval: int = 2000):
        pass
```
```

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

### ActivityHandler

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Handles activities and should be subclassed.

```APIDOC
## Class: ActivityHandler

### Description
Handles activities and should be subclassed.

### Usage
```python
class ActivityHandler:
    pass
```
```

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

### MiddlewareSet

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

A set of _Middleware_ plugins.

```APIDOC
## Class: MiddlewareSet

### Description
A set of _Middleware_ plugins. The set itself is middleware so you can easily package up a set of middleware that can be composed into a bot with a single _bot.use(mySet)_ call or even into another middleware set using _set.use(mySet)_.

### Usage
```python
class MiddlewareSet:
    pass
```
```

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

### BotFrameworkAdapter

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Defines an adapter to connect a bot to a service endpoint.

```APIDOC
## Class: BotFrameworkAdapter

### Description
Defines an adapter to connect a bot to a service endpoint. Initializes a new instance of the BotFrameworkAdapter class.

### Usage
```python
class BotFrameworkAdapter:
    def __init__(self):
        pass
```
```

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

### UserState

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Manages the reading and writing of user state for your bot to storage. It is created with storage and a namespace.

```APIDOC
## Class: UserState

### Description
Reads and writes user state for your bot to storage. Creates a new UserState instance.

### Parameters
- **storage**: The storage mechanism to use for persisting user state.
- **namespace**: The namespace for the user state.
```

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

### BotState

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Defines a state management object and automates the reading and writing of associated state properties to a storage layer.

```APIDOC
## Class: BotState

### Description
Defines a state management object and automates the reading and writing of associated state properties to a storage layer. Initializes a new instance of the BotState class.

### Usage
```python
class BotState:
    def __init__(self):
        pass
```
```

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

### ChannelServiceHandler

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Initializes a new instance of the ChannelServiceHandler class, using a credential provider.

```APIDOC
## Class: ChannelServiceHandler

### Description
Initializes a new instance of the ChannelServiceHandler class, using a credential provider.

### Usage
```python
class ChannelServiceHandler:
    def __init__(self, credential_provider):
        pass
```
```

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

### TranscriptLoggerMiddleware

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Logs incoming and outgoing activities to a TranscriptStore.

```APIDOC
## Class: TranscriptLoggerMiddleware

### Description
Logs incoming and outgoing activities to a TranscriptStore.

### Usage
```python
class TranscriptLoggerMiddleware:
    pass
```
```

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

### UserTokenProvider

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Provides functionality related to user tokens.

```APIDOC
## Class: UserTokenProvider

### Description
Provides functionality for managing user tokens.
```

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

### Bot

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Represents a bot that can operate on incoming activities.

```APIDOC
## Class: Bot

### Description
Represents a bot that can operate on incoming activities.

### Usage
```python
class Bot:
    pass
```
```

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

### Calculate Change Hash

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Utility function to calculate a change hash for a StoreItem. Requires a StoreItem object as input.

```python
calculate_change_hash(item: StoreItem) -> str
```

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

### calculate_change_hash

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Utility function to calculate a change hash for a _StoreItem_.

```APIDOC
## calculate_change_hash

### Description
Utility function to calculate a change hash for a _StoreItem_.

### Parameters
* **item** (StoreItem) - Required - Description of the item parameter.
```

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

### TurnContext

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Represents the context object that contains information and control flow for a turn of a conversation. It is created with an adapter or another TurnContext and a request.

```APIDOC
## Class: TurnContext

### Description
Creates a new TurnContext instance.

### Parameters
- **adapter_or_context**: The adapter or context to initialize with.
- **request**: The request object for the turn.
```

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

### InvokeResponse

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Tuple class containing an HTTP Status Code and a JSON serializable object.

```APIDOC
## Class: InvokeResponse

### Description
Tuple class containing an HTTP Status Code and a JSON serializable object. The HTTP Status code is, in the invoke activity scenario, what will be set in the resulting POST. The Body of the resulting POST will be JSON serialized content. The body content is defined by the producer. The caller must know what the content is and deserialize as needed. Gets or sets the HTTP status and/or body code for the response.

### Parameters
* **status** (int) - The HTTP status code.
* **body** (object) - The JSON serializable body content for the response. This object must be serializable by the core Python json routines. The caller is responsible for serializing more complex/nested objects into native classes (lists and dictionaries of strings are acceptable).

### Usage
```python
class InvokeResponse:
    def __init__(self, status: int, body: object):
        self.status = status
        self.body = body
```
```

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

### ConversationState

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Defines a state management object for conversation state.

```APIDOC
## Class: ConversationState

### Description
Defines a state management object for conversation state. Creates a ConversationState instance. Creates a new instance of the ConversationState class.

### Parameters
* **storage** (Storage) - The storage containing the conversation state.

### Usage
```python
class ConversationState:
    def __init__(self, storage: Storage):
        pass
```
```

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

### MessageFactory

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

A set of utility functions designed to assist with the formatting of the various message types a bot can return.

```APIDOC
## Class: MessageFactory

### Description
A set of utility functions designed to assist with the formatting of the various message types a bot can return.

### Usage
```python
class MessageFactory:
    pass
```
```

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

### TelemetryLoggerMiddleware

Source: https://learn.microsoft.com/en-us/python/api/botbuilder-core/botbuilder.core?view=botbuilder-py-latest

Middleware for logging incoming, outgoing, updated or deleted Activity messages.

```APIDOC
## Class: TelemetryLoggerMiddleware

### Description
Middleware for logging incoming, outgoing, updated or deleted Activity messages.

### Usage
```python
class TelemetryLoggerMiddleware:
    pass
```
```
Tokens:
Raw