WebChatSite Class

public final class WebChatSite
extends Site

A site for the Webchat channel.

Constructor Summary

Constructor Description
WebChatSite()

Creates an instance of WebChatSite class.

Method Summary

Modifier and Type Method and Description
static WebChatSite fromJson(JsonReader jsonReader)

Reads an instance of WebChatSite from the JsonReader.

Boolean isTokenEnabled()

Get the isTokenEnabled property: Whether this site is token enabled for channel.

String key()

Get the key property: Primary key.

String key2()

Get the key2 property: Secondary key.

String siteId()

Get the siteId property: Site Id.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

WebChatSite withAppId(String appId)

Set the appId property: DirectLine application id.

WebChatSite withEtag(String etag)

Set the etag property: Entity Tag.

WebChatSite withIsBlockUserUploadEnabled(Boolean isBlockUserUploadEnabled)

Set the isBlockUserUploadEnabled property: Whether this site is enabled for block user upload.

WebChatSite withIsDetailedLoggingEnabled(Boolean isDetailedLoggingEnabled)

Set the isDetailedLoggingEnabled property: Whether this site is disabled detailed logging for.

WebChatSite withIsEnabled(boolean isEnabled)

Set the isEnabled property: Whether this site is enabled for DirectLine channel.

WebChatSite withIsEndpointParametersEnabled(Boolean isEndpointParametersEnabled)

Set the isEndpointParametersEnabled property: Whether this site is EndpointParameters enabled for channel.

WebChatSite withIsNoStorageEnabled(Boolean isNoStorageEnabled)

Set the isNoStorageEnabled property: Whether this no-storage site is disabled detailed logging for.

WebChatSite withIsSecureSiteEnabled(Boolean isSecureSiteEnabled)

Set the isSecureSiteEnabled property: Whether this site is enabled for authentication with Bot Framework.

WebChatSite withIsV1Enabled(Boolean isV1Enabled)

Set the isV1Enabled property: Whether this site is enabled for Bot Framework V1 protocol.

WebChatSite withIsV3Enabled(Boolean isV3Enabled)

Set the isV3Enabled property: Whether this site is enabled for Bot Framework V3 protocol.

WebChatSite withIsWebchatPreviewEnabled(Boolean isWebchatPreviewEnabled)

Set the isWebchatPreviewEnabled property: Whether this site is enabled for preview versions of Webchat.

WebChatSite withIsWebChatSpeechEnabled(Boolean isWebChatSpeechEnabled)

Set the isWebChatSpeechEnabled property: Whether this site is enabled for Webchat Speech.

WebChatSite withSiteName(String siteName)

Set the siteName property: Site name.

WebChatSite withTenantId(String tenantId)

Set the tenantId property: Tenant Id.

WebChatSite withTrustedOrigins(List<String> trustedOrigins)

Set the trustedOrigins property: List of Trusted Origin URLs for this site.

Methods inherited from Site

Methods inherited from java.lang.Object

Constructor Details

WebChatSite

public WebChatSite()

Creates an instance of WebChatSite class.

Method Details

fromJson

public static WebChatSite fromJson(JsonReader jsonReader)

Reads an instance of WebChatSite from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WebChatSite if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

isTokenEnabled

public Boolean isTokenEnabled()

Get the isTokenEnabled property: Whether this site is token enabled for channel.

Overrides:

WebChatSite.isTokenEnabled()

Returns:

the isTokenEnabled value.

key

public String key()

Get the key property: Primary key. Value only returned through POST to the action Channel List API, otherwise empty.

Overrides:

WebChatSite.key()

Returns:

the key value.

key2

public String key2()

Get the key2 property: Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.

Overrides:

WebChatSite.key2()

Returns:

the key2 value.

siteId

public String siteId()

Get the siteId property: Site Id.

Overrides:

WebChatSite.siteId()

Returns:

the siteId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

WebChatSite.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

WebChatSite.validate()

withAppId

public WebChatSite withAppId(String appId)

Set the appId property: DirectLine application id.

Overrides:

WebChatSite.withAppId(String appId)

Parameters:

appId

withEtag

public WebChatSite withEtag(String etag)

Set the etag property: Entity Tag.

Overrides:

WebChatSite.withEtag(String etag)

Parameters:

etag

withIsBlockUserUploadEnabled

public WebChatSite withIsBlockUserUploadEnabled(Boolean isBlockUserUploadEnabled)

Set the isBlockUserUploadEnabled property: Whether this site is enabled for block user upload.

Overrides:

WebChatSite.withIsBlockUserUploadEnabled(Boolean isBlockUserUploadEnabled)

Parameters:

isBlockUserUploadEnabled

withIsDetailedLoggingEnabled

public WebChatSite withIsDetailedLoggingEnabled(Boolean isDetailedLoggingEnabled)

Set the isDetailedLoggingEnabled property: Whether this site is disabled detailed logging for.

Overrides:

WebChatSite.withIsDetailedLoggingEnabled(Boolean isDetailedLoggingEnabled)

Parameters:

isDetailedLoggingEnabled

withIsEnabled

public WebChatSite withIsEnabled(boolean isEnabled)

Set the isEnabled property: Whether this site is enabled for DirectLine channel.

Overrides:

WebChatSite.withIsEnabled(boolean isEnabled)

Parameters:

isEnabled

withIsEndpointParametersEnabled

public WebChatSite withIsEndpointParametersEnabled(Boolean isEndpointParametersEnabled)

Set the isEndpointParametersEnabled property: Whether this site is EndpointParameters enabled for channel.

Overrides:

WebChatSite.withIsEndpointParametersEnabled(Boolean isEndpointParametersEnabled)

Parameters:

isEndpointParametersEnabled

withIsNoStorageEnabled

public WebChatSite withIsNoStorageEnabled(Boolean isNoStorageEnabled)

Set the isNoStorageEnabled property: Whether this no-storage site is disabled detailed logging for.

Overrides:

WebChatSite.withIsNoStorageEnabled(Boolean isNoStorageEnabled)

Parameters:

isNoStorageEnabled

withIsSecureSiteEnabled

public WebChatSite withIsSecureSiteEnabled(Boolean isSecureSiteEnabled)

Set the isSecureSiteEnabled property: Whether this site is enabled for authentication with Bot Framework.

Overrides:

WebChatSite.withIsSecureSiteEnabled(Boolean isSecureSiteEnabled)

Parameters:

isSecureSiteEnabled

withIsV1Enabled

public WebChatSite withIsV1Enabled(Boolean isV1Enabled)

Set the isV1Enabled property: Whether this site is enabled for Bot Framework V1 protocol.

Overrides:

WebChatSite.withIsV1Enabled(Boolean isV1Enabled)

Parameters:

isV1Enabled

withIsV3Enabled

public WebChatSite withIsV3Enabled(Boolean isV3Enabled)

Set the isV3Enabled property: Whether this site is enabled for Bot Framework V3 protocol.

Overrides:

WebChatSite.withIsV3Enabled(Boolean isV3Enabled)

Parameters:

isV3Enabled

withIsWebchatPreviewEnabled

public WebChatSite withIsWebchatPreviewEnabled(Boolean isWebchatPreviewEnabled)

Set the isWebchatPreviewEnabled property: Whether this site is enabled for preview versions of Webchat.

Overrides:

WebChatSite.withIsWebchatPreviewEnabled(Boolean isWebchatPreviewEnabled)

Parameters:

isWebchatPreviewEnabled

withIsWebChatSpeechEnabled

public WebChatSite withIsWebChatSpeechEnabled(Boolean isWebChatSpeechEnabled)

Set the isWebChatSpeechEnabled property: Whether this site is enabled for Webchat Speech.

Overrides:

WebChatSite.withIsWebChatSpeechEnabled(Boolean isWebChatSpeechEnabled)

Parameters:

isWebChatSpeechEnabled

withSiteName

public WebChatSite withSiteName(String siteName)

Set the siteName property: Site name.

Overrides:

WebChatSite.withSiteName(String siteName)

Parameters:

siteName

withTenantId

public WebChatSite withTenantId(String tenantId)

Set the tenantId property: Tenant Id.

Overrides:

WebChatSite.withTenantId(String tenantId)

Parameters:

tenantId

withTrustedOrigins

public WebChatSite withTrustedOrigins(List<String> trustedOrigins)

Set the trustedOrigins property: List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.

Overrides:

WebChatSite.withTrustedOrigins(List<String> trustedOrigins)

Parameters:

trustedOrigins

Applies to