DialogServiceConfig Class

Class that defines base configurations for the dialog service connector object that can communicate with a voice assistant.

This class is base class for BotFrameworkConfig and CustomCommandsConfig classes. Create dialog config instances from specific BotFrameworkConfig or CustomCommandsConfig objects.

Inheritance

builtins.object

DialogServiceConfig

Constructor

DialogServiceConfig(handle: c_void_p)

Parameters

Name	Description
handle Required

Methods

get_property	Get a property by id.
get_property_by_name	Get a property by name.
set_property	Set a property by id.
set_property_by_name	Set a property by name.
set_proxy	Set proxy information. Note Proxy functionality is not available on macOS. This function will have no effect on this platform.
set_service_property	Sets a property value that will be passed to service using the specified channel.

get_property

Get a property by id.

get_property(property_id: PropertyId) -> str

Parameters

Name	Description
property_id Required	The id of the property to be retrieved.

Returns

Type	Description
	The value of the property.

get_property_by_name

Get a property by name.

get_property_by_name(property_name: str) -> str

Parameters

Name	Description
property_name Required	The name of the property to be retrieved.

Returns

Type	Description
	The value of the property.

set_property

Set a property by id.

set_property(property_id: PropertyId, value: str)

Parameters

Name	Description
property_id Required	The id of the property to be set.
value Required	The value to be set for the property.

set_property_by_name

Set a property by name.

set_property_by_name(property_name: str, value: str)

Parameters

Name	Description
property_name Required	The name of the property to be set.
value Required	The value to be set for the property.

set_proxy

Set proxy information.

Note

Proxy functionality is not available on macOS. This function will have no effect on

this platform.

set_proxy(hostname: str, port: str, username: str, password: str)

Parameters

Name	Description
hostname Required	The host name of the proxy server. Do not add protocol information (http) to the hostname.
port Required	The port number of the proxy server.
username Required	The user name of the proxy server.
password Required	The password of the proxy server.

set_service_property

Sets a property value that will be passed to service using the specified channel.

set_service_property(name: str, value: str, channel: ServicePropertyChannel)

Parameters

Name	Description
name Required	The property name.
value Required	The property value.
channel Required	The channel used to pass the specified property to service.

Attributes

language

The language identifier used for speech-to-text, expressed in BCP-47 format.