WebChatSite interface

Package:

@azure/arm-botservice

A site for the Webchat channel

Extends

Site

Inherited Properties

appId	DirectLine application id
eTag	Entity Tag
isBlockUserUploadEnabled	Whether this site is enabled for block user upload.
isDetailedLoggingEnabled	Whether this site is disabled detailed logging for
isEnabled	Whether this site is enabled for DirectLine channel
isEndpointParametersEnabled	Whether this site is EndpointParameters enabled for channel
isNoStorageEnabled	Whether this no-storage site is disabled detailed logging for
isSecureSiteEnabled	Whether this site is enabled for authentication with Bot Framework.
isTokenEnabled	Whether this site is token enabled for channel NOTE: This property will not be serialized. It can only be populated by the server.
isV1Enabled	Whether this site is enabled for Bot Framework V1 protocol.
isV3Enabled	Whether this site is enabled for Bot Framework V3 protocol.
isWebchatPreviewEnabled	Whether this site is enabled for preview versions of Webchat
isWebChatSpeechEnabled	Whether this site is enabled for Webchat Speech
key	Primary key. Value only returned through POST to the action Channel List API, otherwise empty. NOTE: This property will not be serialized. It can only be populated by the server.
key2	Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. NOTE: This property will not be serialized. It can only be populated by the server.
siteId	Site Id NOTE: This property will not be serialized. It can only be populated by the server.
siteName	Site name
tenantId	Tenant Id
trustedOrigins	List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.

Inherited Property Details

appId

DirectLine application id

appId?: string

Property Value

string

Inherited From Site.appId

eTag

Entity Tag

eTag?: string

Property Value

string

Inherited From Site.eTag

isBlockUserUploadEnabled

Whether this site is enabled for block user upload.

isBlockUserUploadEnabled?: boolean

Property Value

boolean

Inherited From Site.isBlockUserUploadEnabled

isDetailedLoggingEnabled

Whether this site is disabled detailed logging for

isDetailedLoggingEnabled?: boolean

Property Value

boolean

Inherited From Site.isDetailedLoggingEnabled

isEnabled

Whether this site is enabled for DirectLine channel

isEnabled: boolean

Property Value

boolean

Inherited From Site.isEnabled

isEndpointParametersEnabled

Whether this site is EndpointParameters enabled for channel

isEndpointParametersEnabled?: boolean

Property Value

boolean

Inherited From Site.isEndpointParametersEnabled

isNoStorageEnabled

Whether this no-storage site is disabled detailed logging for

isNoStorageEnabled?: boolean

Property Value

boolean

Inherited From Site.isNoStorageEnabled

isSecureSiteEnabled

Whether this site is enabled for authentication with Bot Framework.

isSecureSiteEnabled?: boolean

Property Value

boolean

Inherited From Site.isSecureSiteEnabled

isTokenEnabled

Whether this site is token enabled for channel NOTE: This property will not be serialized. It can only be populated by the server.

isTokenEnabled?: boolean

Property Value

boolean

Inherited From Site.isTokenEnabled

isV1Enabled

Whether this site is enabled for Bot Framework V1 protocol.

isV1Enabled?: boolean

Property Value

boolean

Inherited From Site.isV1Enabled

isV3Enabled

Whether this site is enabled for Bot Framework V3 protocol.

isV3Enabled?: boolean

Property Value

boolean

Inherited From Site.isV3Enabled

isWebchatPreviewEnabled

Whether this site is enabled for preview versions of Webchat

isWebchatPreviewEnabled?: boolean

Property Value

boolean

Inherited From Site.isWebchatPreviewEnabled

isWebChatSpeechEnabled

Whether this site is enabled for Webchat Speech

isWebChatSpeechEnabled?: boolean

Property Value

boolean

Inherited From Site.isWebChatSpeechEnabled

key

Primary key. Value only returned through POST to the action Channel List API, otherwise empty. NOTE: This property will not be serialized. It can only be populated by the server.

key?: string

Property Value

string

Inherited From Site.key

key2

Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. NOTE: This property will not be serialized. It can only be populated by the server.

key2?: string

Property Value

string

Inherited From Site.key2

siteId

Site Id NOTE: This property will not be serialized. It can only be populated by the server.

siteId?: string

Property Value

string

Inherited From Site.siteId

siteName

Site name

siteName: string

Property Value

string

Inherited From Site.siteName

tenantId

Tenant Id

tenantId?: string

Property Value

string

Inherited From Site.tenantId

trustedOrigins

List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.

trustedOrigins?: string[]

Property Value

string[]

Inherited From Site.trustedOrigins