|
| 1 | +### YamlMime:JavaType |
| 2 | +uid: "com.azure.communication.common.MicrosoftBotIdentifier" |
| 3 | +fullName: "com.azure.communication.common.MicrosoftBotIdentifier" |
| 4 | +name: "MicrosoftBotIdentifier" |
| 5 | +nameWithType: "MicrosoftBotIdentifier" |
| 6 | +summary: "Communication identifier for Microsoft Bot" |
| 7 | +inheritances: |
| 8 | +- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />" |
| 9 | +- "<xref href=\"com.azure.communication.common.CommunicationIdentifier?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />" |
| 10 | +inheritedClassMethods: |
| 11 | +- classRef: "<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />" |
| 12 | + methodsRef: |
| 13 | + - "<xref href=\"com.azure.communication.common.CommunicationIdentifier.equals(java.lang.Object)?alt=com.azure.communication.common.CommunicationIdentifier.equals&text=equals\" data-throw-if-not-resolved=\"False\" />" |
| 14 | + - "<xref href=\"com.azure.communication.common.CommunicationIdentifier.fromRawId(java.lang.String)?alt=com.azure.communication.common.CommunicationIdentifier.fromRawId&text=fromRawId\" data-throw-if-not-resolved=\"False\" />" |
| 15 | + - "<xref href=\"com.azure.communication.common.CommunicationIdentifier.getRawId()?alt=com.azure.communication.common.CommunicationIdentifier.getRawId&text=getRawId\" data-throw-if-not-resolved=\"False\" />" |
| 16 | + - "<xref href=\"com.azure.communication.common.CommunicationIdentifier.hashCode()?alt=com.azure.communication.common.CommunicationIdentifier.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />" |
| 17 | + - "<xref href=\"com.azure.communication.common.CommunicationIdentifier.setRawId(java.lang.String)?alt=com.azure.communication.common.CommunicationIdentifier.setRawId&text=setRawId\" data-throw-if-not-resolved=\"False\" />" |
| 18 | +- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>" |
| 19 | + methodsRef: |
| 20 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>" |
| 21 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>" |
| 22 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>" |
| 23 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>" |
| 24 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>" |
| 25 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>" |
| 26 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>" |
| 27 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>" |
| 28 | + - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>" |
| 29 | +syntax: "public final class **MicrosoftBotIdentifier**</br> extends <xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />" |
| 30 | +constructors: |
| 31 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.MicrosoftBotIdentifier(java.lang.String)" |
| 32 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.MicrosoftBotIdentifier(String botId)" |
| 33 | + name: "MicrosoftBotIdentifier(String botId)" |
| 34 | + nameWithType: "MicrosoftBotIdentifier.MicrosoftBotIdentifier(String botId)" |
| 35 | + summary: "Creates a Microsoft<wbr>Bot<wbr>Identifier object" |
| 36 | + parameters: |
| 37 | + - description: "Id of the Microsoft bot." |
| 38 | + name: "botId" |
| 39 | + type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>" |
| 40 | + syntax: "public MicrosoftBotIdentifier(String botId)" |
| 41 | + desc: "Creates a MicrosoftBotIdentifier object" |
| 42 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.MicrosoftBotIdentifier(java.lang.String,boolean)" |
| 43 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured)" |
| 44 | + name: "MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured)" |
| 45 | + nameWithType: "MicrosoftBotIdentifier.MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured)" |
| 46 | + summary: "Creates a Microsoft<wbr>Bot<wbr>Identifier object" |
| 47 | + parameters: |
| 48 | + - description: "Id of the Microsoft bot." |
| 49 | + name: "botId" |
| 50 | + type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>" |
| 51 | + - description: "set this to true if the bot is tenantized. It is false if the bot is global and no resource account is configured." |
| 52 | + name: "isResourceAccountConfigured" |
| 53 | + type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />" |
| 54 | + syntax: "public MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured)" |
| 55 | + desc: "Creates a MicrosoftBotIdentifier object" |
| 56 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.MicrosoftBotIdentifier(java.lang.String,boolean,com.azure.communication.common.CommunicationCloudEnvironment)" |
| 57 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured, CommunicationCloudEnvironment cloudEnvironment)" |
| 58 | + name: "MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured, CommunicationCloudEnvironment cloudEnvironment)" |
| 59 | + nameWithType: "MicrosoftBotIdentifier.MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured, CommunicationCloudEnvironment cloudEnvironment)" |
| 60 | + summary: "Creates a Microsoft<wbr>Bot<wbr>Identifier object" |
| 61 | + parameters: |
| 62 | + - description: "botId The unique Microsoft app ID for the bot as registered with the Bot Framework." |
| 63 | + name: "botId" |
| 64 | + type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>" |
| 65 | + - description: "set this to true if the bot is tenantized. It is false if the bot is global and no resource account is configured." |
| 66 | + name: "isResourceAccountConfigured" |
| 67 | + type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />" |
| 68 | + - description: "the cloud environment in which this identifier is created." |
| 69 | + name: "cloudEnvironment" |
| 70 | + type: "<xref href=\"com.azure.communication.common.CommunicationCloudEnvironment?alt=com.azure.communication.common.CommunicationCloudEnvironment&text=CommunicationCloudEnvironment\" data-throw-if-not-resolved=\"False\" />" |
| 71 | + syntax: "public MicrosoftBotIdentifier(String botId, boolean isResourceAccountConfigured, CommunicationCloudEnvironment cloudEnvironment)" |
| 72 | + desc: "Creates a MicrosoftBotIdentifier object" |
| 73 | +methods: |
| 74 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.equals(java.lang.Object)" |
| 75 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.equals(Object that)" |
| 76 | + name: "equals(Object that)" |
| 77 | + nameWithType: "MicrosoftBotIdentifier.equals(Object that)" |
| 78 | + overridden: "com.azure.communication.common.CommunicationIdentifier.equals(java.lang.Object)" |
| 79 | + parameters: |
| 80 | + - name: "that" |
| 81 | + type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>" |
| 82 | + syntax: "public boolean equals(Object that)" |
| 83 | + returns: |
| 84 | + type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />" |
| 85 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.getBotId()" |
| 86 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.getBotId()" |
| 87 | + name: "getBotId()" |
| 88 | + nameWithType: "MicrosoftBotIdentifier.getBotId()" |
| 89 | + summary: "Get bot Id" |
| 90 | + syntax: "public String getBotId()" |
| 91 | + desc: "Get bot Id" |
| 92 | + returns: |
| 93 | + description: "bot Id of the Microsoft bot." |
| 94 | + type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>" |
| 95 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.getCloudEnvironment()" |
| 96 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.getCloudEnvironment()" |
| 97 | + name: "getCloudEnvironment()" |
| 98 | + nameWithType: "MicrosoftBotIdentifier.getCloudEnvironment()" |
| 99 | + summary: "Get cloud environment of the bot identifier" |
| 100 | + syntax: "public CommunicationCloudEnvironment getCloudEnvironment()" |
| 101 | + desc: "Get cloud environment of the bot identifier" |
| 102 | + returns: |
| 103 | + description: "cloud environment in which this identifier is created" |
| 104 | + type: "<xref href=\"com.azure.communication.common.CommunicationCloudEnvironment?alt=com.azure.communication.common.CommunicationCloudEnvironment&text=CommunicationCloudEnvironment\" data-throw-if-not-resolved=\"False\" />" |
| 105 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.hashCode()" |
| 106 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.hashCode()" |
| 107 | + name: "hashCode()" |
| 108 | + nameWithType: "MicrosoftBotIdentifier.hashCode()" |
| 109 | + overridden: "com.azure.communication.common.CommunicationIdentifier.hashCode()" |
| 110 | + syntax: "public int hashCode()" |
| 111 | + returns: |
| 112 | + type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />" |
| 113 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.isResourceAccountConfigured()" |
| 114 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.isResourceAccountConfigured()" |
| 115 | + name: "isResourceAccountConfigured()" |
| 116 | + nameWithType: "MicrosoftBotIdentifier.isResourceAccountConfigured()" |
| 117 | + syntax: "public boolean isResourceAccountConfigured()" |
| 118 | + returns: |
| 119 | + description: "True if the bot is tenantized. It is False if the bot is global and no resource account is configured." |
| 120 | + type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />" |
| 121 | +- uid: "com.azure.communication.common.MicrosoftBotIdentifier.setRawId(java.lang.String)" |
| 122 | + fullName: "com.azure.communication.common.MicrosoftBotIdentifier.setRawId(String rawId)" |
| 123 | + name: "setRawId(String rawId)" |
| 124 | + nameWithType: "MicrosoftBotIdentifier.setRawId(String rawId)" |
| 125 | + summary: "Set full id of the identifier Raw<wbr>Id is the encoded format for identifiers to store in databases or as stable keys in general." |
| 126 | + overridden: "com.azure.communication.common.CommunicationIdentifier.setRawId(java.lang.String)" |
| 127 | + parameters: |
| 128 | + - description: "full id of the identifier" |
| 129 | + name: "rawId" |
| 130 | + type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>" |
| 131 | + syntax: "public MicrosoftBotIdentifier setRawId(String rawId)" |
| 132 | + desc: "Set full id of the identifier RawId is the encoded format for identifiers to store in databases or as stable keys in general." |
| 133 | + returns: |
| 134 | + description: "MicrosoftBotIdentifier object itself" |
| 135 | + type: "<xref href=\"com.azure.communication.common.MicrosoftBotIdentifier?alt=com.azure.communication.common.MicrosoftBotIdentifier&text=MicrosoftBotIdentifier\" data-throw-if-not-resolved=\"False\" />" |
| 136 | +type: "class" |
| 137 | +desc: "Communication identifier for Microsoft Bot" |
| 138 | +metadata: {} |
| 139 | +package: "com.azure.communication.common" |
| 140 | +artifact: com.azure:azure-communication-common:2.0.0-beta.1 |
0 commit comments