com.azure.android.communication.common

Class MicrosoftBotIdentifier

java.lang.Object

com.azure.android.communication.common.CommunicationIdentifier

com.azure.android.communication.common.MicrosoftBotIdentifier

public final class MicrosoftBotIdentifier
extends CommunicationIdentifier

Communication identifier for a Microsoft bot.

Constructor Summary

Constructors

Constructor and Description
MicrosoftBotIdentifier(java.lang.String botId) Creates a MicrosoftBotIdentifier object
MicrosoftBotIdentifier(java.lang.String botId, boolean isResourceAccountConfigured) Creates a MicrosoftBotIdentifier object
MicrosoftBotIdentifier(java.lang.String botId, boolean isResourceAccountConfigured, CommunicationCloudEnvironment cloudEnvironment) Creates a MicrosoftBotIdentifier object

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object that)
java.lang.String	getBotId() Get the Microsoft app ID for the bot.
CommunicationCloudEnvironment	getCloudEnvironment() Get cloud environment of the Microsoft bot identifier.
int	hashCode()
boolean	isResourceAccountConfigured()
MicrosoftBotIdentifier	setRawId(java.lang.String rawId) Set full id of the identifier.

Methods inherited from class com.azure.android.communication.common.CommunicationIdentifier

fromRawId, getRawId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MicrosoftBotIdentifier

public MicrosoftBotIdentifier(java.lang.String botId,
                              boolean isResourceAccountConfigured,
                              CommunicationCloudEnvironment cloudEnvironment)

Creates a MicrosoftBotIdentifier object

Parameters:

botId - The unique Microsoft app ID for the bot as registered with the Bot Framework.

isResourceAccountConfigured - Set this to true if the bot is tenantized. It is false if the bot is global and no resource account is configured.

cloudEnvironment - the cloud environment in which this identifier is created.

Throws:

java.lang.IllegalArgumentException - thrown if botId parameter fail the validation.

MicrosoftBotIdentifier

public MicrosoftBotIdentifier(java.lang.String botId,
                              boolean isResourceAccountConfigured)

Creates a MicrosoftBotIdentifier object

Parameters:

botId - The unique Microsoft app ID for the bot as registered with the Bot Framework.

isResourceAccountConfigured - Set this to true if the bot is tenantized. It is false if the bot is global and no resource account is configured.

Throws:

java.lang.IllegalArgumentException - thrown if botId parameter fail the validation.

MicrosoftBotIdentifier

public MicrosoftBotIdentifier(java.lang.String botId)

Creates a MicrosoftBotIdentifier object

Parameters:

botId - The unique Microsoft app ID for the bot as registered with the Bot Framework.

Throws:

java.lang.IllegalArgumentException - thrown if botId parameter fail the validation.

Method Detail

getBotId

public java.lang.String getBotId()

Get the Microsoft app ID for the bot.

Returns:

microsoftBotId Id of the Microsoft app ID for the bot.

isResourceAccountConfigured

public boolean isResourceAccountConfigured()

Returns:

True if the bot is tenantized and false if the bot is global and no resource account is configured.

getCloudEnvironment

public CommunicationCloudEnvironment getCloudEnvironment()

Get cloud environment of the Microsoft bot identifier.

Returns:

cloud environment in which this identifier is created.

setRawId

public MicrosoftBotIdentifier setRawId(java.lang.String rawId)

Set full id of the identifier. RawId is the encoded format for identifiers to store in databases or as stable keys in general.

Overrides:

setRawId in class CommunicationIdentifier

Parameters:

rawId - full id of the identifier.

Returns:

MicrosoftBotIdentifier object itself.

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class CommunicationIdentifier

hashCode

public int hashCode()

Overrides:

hashCode in class CommunicationIdentifier