Class SPXDialogServiceConfiguration

  • Article

Declaration

@class SPXDialogServiceConfiguration : NSObject;

Description

The base configuration type used to create a DialogServiceConnector that can communicate with a voice assistant.

SPXDialogServiceConfiguration objects should be initialized directly. Derived objects like SPXDialogBotFrameworkConfiguration should be instantiated, instead.

Methods

getPropertyByName:

Returns the value of a configuration property using an explicit string literal as a key. If a property with the provided key is not available, an empty string is returned.

- (NSString * _Nullable)getPropertyByName:(NSString * _Nonnull)name

Parameters

  • name - the name of the configuration property used as a key to the desired value.

Returns

the value of the indexed configuration property or an empty string if the key is not found.

getPropertyById:

Returns the value of a configuration property using a known property ID as a key. If a property with the provided key is not available, an empty string is returned.

- (NSString * _Nullable)getPropertyById:(SPXPropertyId)propertyId

Parameters

  • propertyId - the property ID for the configuration property.

Returns

the value of the configuration property or an empty string if the key is not found.

setPropertyTo:byName:

Sets the value of a configuration property using a provided string literal as the key.

- (void)setPropertyTo:(NSString * _Nonnull)value byName:(NSString * _Nonnull)name

Parameters

  • value - the value to set for the configuration property.
  • name - the name of the configuration property to use as a key for its value.

setPropertyTo:byId:

Sets the value of a configuration property using a known property ID as the key.

- (void)setPropertyTo:(NSString * _Nonnull)value byId:(SPXPropertyId)id

Parameters

  • value - the value to set for the configuration property.
  • id - the property ID for the configuration property.

setServicePropertyTo:byName:usingChannel:

Sets an advanced configuration property that's encoded into the speech service request upon connection. This is typically used for preview features not available via a well-supported property ID.

- (void)setServicePropertyTo:(NSString * _Nonnull)value byName:(NSString * _Nonnull)name
    usingChannel:(SPXServicePropertyChannel)channel

Parameters

  • value - the property value.
  • name - the property name.
  • channel - the channel used to pass the specified property to service.

Properties

language

@property (readwrite, copy, nonatomic) NSString * _Nullable language;

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