ChannelSettings Class

Package:

com.azure.resourcemanager.botservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-botservice:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.botservice.models.ChannelSettings

Implements

JsonSerializable<ChannelSettings>

public final class ChannelSettings
implements JsonSerializable<ChannelSettings>

Channel settings definition.

Constructor Summary

Constructor	Description
ChannelSettings()	Creates an instance of ChannelSettings class.

Method Summary

Modifier and Type	Method and Description
String	botIconUrl() Get the botIconUrl property: The bot icon url.
String	botId() Get the botId property: The bot id.
String	channelDisplayName() Get the channelDisplayName property: The channel display name.
String	channelId() Get the channelId property: The channel id.
Boolean	disableLocalAuth() Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
String	extensionKey1() Get the extensionKey1 property: The extensionKey1.
String	extensionKey2() Get the extensionKey2 property: The extensionKey2.
static ChannelSettings	fromJson(JsonReader jsonReader) Reads an instance of ChannelSettings from the JsonReader.
Boolean	isEnabled() Get the isEnabled property: Whether this channel is enabled for the bot.
Boolean	requireTermsAgreement() Get the requireTermsAgreement property: Whether customer needs to agree to new terms.
List<Site>	sites() Get the sites property: The list of sites.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ChannelSettings	withBotIconUrl(String botIconUrl) Set the botIconUrl property: The bot icon url.
ChannelSettings	withBotId(String botId) Set the botId property: The bot id.
ChannelSettings	withChannelDisplayName(String channelDisplayName) Set the channelDisplayName property: The channel display name.
ChannelSettings	withChannelId(String channelId) Set the channelId property: The channel id.
ChannelSettings	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
ChannelSettings	withExtensionKey1(String extensionKey1) Set the extensionKey1 property: The extensionKey1.
ChannelSettings	withExtensionKey2(String extensionKey2) Set the extensionKey2 property: The extensionKey2.
ChannelSettings	withIsEnabled(Boolean isEnabled) Set the isEnabled property: Whether this channel is enabled for the bot.
ChannelSettings	withRequireTermsAgreement(Boolean requireTermsAgreement) Set the requireTermsAgreement property: Whether customer needs to agree to new terms.
ChannelSettings	withSites(List<Site> sites) Set the sites property: The list of sites.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ChannelSettings

public ChannelSettings()

Creates an instance of ChannelSettings class.

Method Details

botIconUrl

public String botIconUrl()

Get the botIconUrl property: The bot icon url.

Returns:

the botIconUrl value.

botId

public String botId()

Get the botId property: The bot id.

Returns:

the botId value.

channelDisplayName

public String channelDisplayName()

Get the channelDisplayName property: The channel display name.

Returns:

the channelDisplayName value.

channelId

public String channelId()

Get the channelId property: The channel id.

Returns:

the channelId value.

disableLocalAuth

public Boolean disableLocalAuth()

Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

Returns:

the disableLocalAuth value.

extensionKey1

public String extensionKey1()

Get the extensionKey1 property: The extensionKey1.

Returns:

the extensionKey1 value.

extensionKey2

public String extensionKey2()

Get the extensionKey2 property: The extensionKey2.

Returns:

the extensionKey2 value.

fromJson

public static ChannelSettings fromJson(JsonReader jsonReader)

Reads an instance of ChannelSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the ChannelSettings.

isEnabled

public Boolean isEnabled()

Get the isEnabled property: Whether this channel is enabled for the bot.

Returns:

the isEnabled value.

requireTermsAgreement

public Boolean requireTermsAgreement()

Get the requireTermsAgreement property: Whether customer needs to agree to new terms.

Returns:

the requireTermsAgreement value.

sites

public List<Site> sites()

Get the sites property: The list of sites.

Returns:

the sites value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withBotIconUrl

public ChannelSettings withBotIconUrl(String botIconUrl)

Set the botIconUrl property: The bot icon url.

Parameters:

botIconUrl - the botIconUrl value to set.

Returns:

the ChannelSettings object itself.

withBotId

public ChannelSettings withBotId(String botId)

Set the botId property: The bot id.

Parameters:

botId - the botId value to set.

Returns:

the ChannelSettings object itself.

withChannelDisplayName

public ChannelSettings withChannelDisplayName(String channelDisplayName)

Set the channelDisplayName property: The channel display name.

Parameters:

channelDisplayName - the channelDisplayName value to set.

Returns:

the ChannelSettings object itself.

withChannelId

public ChannelSettings withChannelId(String channelId)

Set the channelId property: The channel id.

Parameters:

channelId - the channelId value to set.

Returns:

the ChannelSettings object itself.

withDisableLocalAuth

public ChannelSettings withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

Parameters:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the ChannelSettings object itself.

withExtensionKey1

public ChannelSettings withExtensionKey1(String extensionKey1)

Set the extensionKey1 property: The extensionKey1.

Parameters:

extensionKey1 - the extensionKey1 value to set.

Returns:

the ChannelSettings object itself.

withExtensionKey2

public ChannelSettings withExtensionKey2(String extensionKey2)

Set the extensionKey2 property: The extensionKey2.

Parameters:

extensionKey2 - the extensionKey2 value to set.

Returns:

the ChannelSettings object itself.

withIsEnabled

public ChannelSettings withIsEnabled(Boolean isEnabled)

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

Parameters:

isEnabled - the isEnabled value to set.

Returns:

the ChannelSettings object itself.

withRequireTermsAgreement

public ChannelSettings withRequireTermsAgreement(Boolean requireTermsAgreement)

Set the requireTermsAgreement property: Whether customer needs to agree to new terms.

Parameters:

requireTermsAgreement - the requireTermsAgreement value to set.

Returns:

the ChannelSettings object itself.

withSites

public ChannelSettings withSites(List<Site> sites)

Set the sites property: The list of sites.

Parameters:

sites - the sites value to set.

Returns:

the ChannelSettings object itself.