Package com.azure.communication.common

Class MicrosoftTeamsUserIdentifier

java.lang.Object
com.azure.communication.common.CommunicationIdentifier
com.azure.communication.common.MicrosoftTeamsUserIdentifier
public final class MicrosoftTeamsUserIdentifier extends CommunicationIdentifier
Communication identifier for Microsoft Teams User

  • Constructor Details

    • MicrosoftTeamsUserIdentifier

      public MicrosoftTeamsUserIdentifier(String userId, boolean isAnonymous)
      Creates a MicrosoftTeamsUserIdentifier object
      Parameters:
      userId - Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user.
      isAnonymous - set this to true if the user is anonymous, for example when joining a meeting with a share link
      Throws:
      IllegalArgumentException - thrown if userId parameter fail the validation.

    • MicrosoftTeamsUserIdentifier

      public MicrosoftTeamsUserIdentifier(String userId)
      Creates a MicrosoftTeamsUserIdentifier object
      Parameters:
      userId - Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user.
      Throws:
      IllegalArgumentException - thrown if userId parameter fail the validation.

  • Method Details

    • getUserId

      public String getUserId()
      Get Teams User Id
      Returns:
      userId Id of the Microsoft Teams user. If the user isn't anonymous, the id is the Azure AD object id of the user.

    • isAnonymous

      public boolean isAnonymous()
      Returns:
      True if the user is anonymous, for example when joining a meeting with a share link.

    • getCloudEnvironment

      public CommunicationCloudEnvironment getCloudEnvironment()
      Get cloud environment of the Teams user identifier
      Returns:
      cloud environment in which this identifier is created

    • setCloudEnvironment

      public MicrosoftTeamsUserIdentifier setCloudEnvironment(CommunicationCloudEnvironment cloudEnvironment)
      Set cloud environment of the Teams user identifier
      Parameters:
      cloudEnvironment - the cloud environment in which this identifier is created
      Returns:
      this object

    • setRawId

      public MicrosoftTeamsUserIdentifier setRawId(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:
      MicrosoftTeamsUserIdentifier object itself

    • equals

      public boolean equals(Object that)
      Overrides:
      equals in class CommunicationIdentifier

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class CommunicationIdentifier