azure-docs-sdk-java/docs-ref-autogen/com.azure.communication.com...

138 строки
11 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier"
name: "MicrosoftTeamsUserIdentifier"
nameWithType: "MicrosoftTeamsUserIdentifier"
summary: "Communication identifier for Microsoft Teams User"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.communication.common.CommunicationIdentifier?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<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\" />"
- "<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\" />"
- "<xref href=\"com.azure.communication.common.CommunicationIdentifier.getRawId()?alt=com.azure.communication.common.CommunicationIdentifier.getRawId&text=getRawId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.communication.common.CommunicationIdentifier.hashCode()?alt=com.azure.communication.common.CommunicationIdentifier.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<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\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **MicrosoftTeamsUserIdentifier**</br> extends <xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.MicrosoftTeamsUserIdentifier(java.lang.String)"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.MicrosoftTeamsUserIdentifier(String userId)"
name: "MicrosoftTeamsUserIdentifier(String userId)"
nameWithType: "MicrosoftTeamsUserIdentifier.MicrosoftTeamsUserIdentifier(String userId)"
summary: "Creates a Microsoft<wbr>Teams<wbr>User<wbr>Identifier object"
parameters:
- description: "Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user."
name: "userId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MicrosoftTeamsUserIdentifier(String userId)"
desc: "Creates a MicrosoftTeamsUserIdentifier object"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.MicrosoftTeamsUserIdentifier(java.lang.String,boolean)"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.MicrosoftTeamsUserIdentifier(String userId, boolean isAnonymous)"
name: "MicrosoftTeamsUserIdentifier(String userId, boolean isAnonymous)"
nameWithType: "MicrosoftTeamsUserIdentifier.MicrosoftTeamsUserIdentifier(String userId, boolean isAnonymous)"
summary: "Creates a Microsoft<wbr>Teams<wbr>User<wbr>Identifier object"
parameters:
- description: "Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user."
name: "userId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "set this to true if the user is anonymous,\n for example when joining a meeting with a share link"
name: "isAnonymous"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MicrosoftTeamsUserIdentifier(String userId, boolean isAnonymous)"
desc: "Creates a MicrosoftTeamsUserIdentifier object"
methods:
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.equals(java.lang.Object)"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.equals(Object that)"
name: "equals(Object that)"
nameWithType: "MicrosoftTeamsUserIdentifier.equals(Object that)"
overridden: "com.azure.communication.common.CommunicationIdentifier.equals(java.lang.Object)"
parameters:
- name: "that"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public boolean equals(Object that)"
returns:
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.getCloudEnvironment()"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.getCloudEnvironment()"
name: "getCloudEnvironment()"
nameWithType: "MicrosoftTeamsUserIdentifier.getCloudEnvironment()"
summary: "Get cloud environment of the Teams user identifier"
syntax: "public CommunicationCloudEnvironment getCloudEnvironment()"
desc: "Get cloud environment of the Teams user identifier"
returns:
description: "cloud environment in which this identifier is created"
type: "<xref href=\"com.azure.communication.common.CommunicationCloudEnvironment?alt=com.azure.communication.common.CommunicationCloudEnvironment&text=CommunicationCloudEnvironment\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.getUserId()"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.getUserId()"
name: "getUserId()"
nameWithType: "MicrosoftTeamsUserIdentifier.getUserId()"
summary: "Get Teams User Id"
syntax: "public String getUserId()"
desc: "Get Teams User Id"
returns:
description: "userId Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.hashCode()"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.hashCode()"
name: "hashCode()"
nameWithType: "MicrosoftTeamsUserIdentifier.hashCode()"
overridden: "com.azure.communication.common.CommunicationIdentifier.hashCode()"
syntax: "public int hashCode()"
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.isAnonymous()"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.isAnonymous()"
name: "isAnonymous()"
nameWithType: "MicrosoftTeamsUserIdentifier.isAnonymous()"
syntax: "public boolean isAnonymous()"
returns:
description: "True if the user is anonymous, for example when joining a meeting with a share link."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.setCloudEnvironment(com.azure.communication.common.CommunicationCloudEnvironment)"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.setCloudEnvironment(CommunicationCloudEnvironment cloudEnvironment)"
name: "setCloudEnvironment(CommunicationCloudEnvironment cloudEnvironment)"
nameWithType: "MicrosoftTeamsUserIdentifier.setCloudEnvironment(CommunicationCloudEnvironment cloudEnvironment)"
summary: "Set cloud environment of the Teams user identifier"
parameters:
- description: "the cloud environment in which this identifier is created"
name: "cloudEnvironment"
type: "<xref href=\"com.azure.communication.common.CommunicationCloudEnvironment?alt=com.azure.communication.common.CommunicationCloudEnvironment&text=CommunicationCloudEnvironment\" data-throw-if-not-resolved=\"False\" />"
syntax: "public MicrosoftTeamsUserIdentifier setCloudEnvironment(CommunicationCloudEnvironment cloudEnvironment)"
desc: "Set cloud environment of the Teams user identifier"
returns:
description: "this object"
type: "<xref href=\"com.azure.communication.common.MicrosoftTeamsUserIdentifier?alt=com.azure.communication.common.MicrosoftTeamsUserIdentifier&text=MicrosoftTeamsUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.setRawId(java.lang.String)"
fullName: "com.azure.communication.common.MicrosoftTeamsUserIdentifier.setRawId(String rawId)"
name: "setRawId(String rawId)"
nameWithType: "MicrosoftTeamsUserIdentifier.setRawId(String rawId)"
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."
overridden: "com.azure.communication.common.CommunicationIdentifier.setRawId(java.lang.String)"
parameters:
- description: "full id of the identifier"
name: "rawId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public MicrosoftTeamsUserIdentifier setRawId(String rawId)"
desc: "Set full id of the identifier RawId is the encoded format for identifiers to store in databases or as stable keys in general."
returns:
description: "MicrosoftTeamsUserIdentifier object itself"
type: "<xref href=\"com.azure.communication.common.MicrosoftTeamsUserIdentifier?alt=com.azure.communication.common.MicrosoftTeamsUserIdentifier&text=MicrosoftTeamsUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Communication identifier for Microsoft Teams User"
metadata: {}
package: "com.azure.communication.common"
artifact: com.azure:azure-communication-common:1.3.8