Index

A B C D E F G H I K N P R S T V 
All Classes and Interfaces|All Packages|Serialized Form

A

addPolicy(HttpPipelinePolicy) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Adds a pipeline policy to apply on each request sent.
Authenticate the client - Search tag in Overview
Section
Azure Active Directory Token Authentication - Search tag in Overview
Section
Azure Communication Identity client library for Java - Search tag in Overview
Section
AzureKeyCredential Authentication - Search tag in Overview
Section

B

buildAsyncClient() - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
buildClient() - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.

C

CHAT - Static variable in class com.azure.communication.identity.models.CommunicationTokenScope
Use this for full access to Chat APIs.
CHAT_JOIN - Static variable in class com.azure.communication.identity.models.CommunicationTokenScope
Access to Chat APIs but without the authorization to create, delete or update chat threads.
CHAT_JOIN_LIMITED - Static variable in class com.azure.communication.identity.models.CommunicationTokenScope
A more limited version of chat.join that doesn't allow to add or remove participants.
clientOptions(ClientOptions) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
com.azure.communication.identity - package com.azure.communication.identity
Package containing the classes for AzureCommunicationIdentity.
com.azure.communication.identity.models - package com.azure.communication.identity.models
Package containing the data models for CommunicationIdentityClient.
CommunicationIdentityAsyncClient - Class in com.azure.communication.identity
Asynchronous client interface for Azure Communication Services Identity operations
CommunicationIdentityClient - Class in com.azure.communication.identity
Synchronous client interface for Azure Communication Service Identity operations
CommunicationIdentityClientBuilder - Class in com.azure.communication.identity
This class provides a fluent builder API to help aid the configuration and instantiation of CommunicationIdentityClients and CommunicationIdentityAsyncClients, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.
CommunicationIdentityClientBuilder() - Constructor for class com.azure.communication.identity.CommunicationIdentityClientBuilder
 
CommunicationIdentityServiceVersion - Enum in com.azure.communication.identity
The versions of Communication Identity Service supported by this client library.
CommunicationTokenScope - Class in com.azure.communication.identity.models
List of scopes for an access token.
CommunicationTokenScope() - Constructor for class com.azure.communication.identity.models.CommunicationTokenScope
Deprecated.
CommunicationUserIdentifierAndToken - Class in com.azure.communication.identity.models
The CommunicationUserIdentifierWithAccessTokenResult model.
CommunicationUserIdentifierAndToken(CommunicationUserIdentifier, AccessToken) - Constructor for class com.azure.communication.identity.models.CommunicationUserIdentifierAndToken
Creates a CommunicationUserIdentifierAndToken object
configuration(Configuration) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the configuration object used to retrieve environment configuration values during building of the client.
connectionString(String) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Set endpoint and credential to use
Connection String Authentication - Search tag in Overview
Section
Contributing - Search tag in Overview
Section
Create a new user and token in a single request - Search tag in Overview
Section
createUser() - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Creates a new CommunicationUserIdentifier.
createUser() - Method in class com.azure.communication.identity.CommunicationIdentityClient
Creates a new CommunicationUserIdentifier.
createUserAndToken(Iterable<CommunicationTokenScope>) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Creates a new CommunicationUserIdentifier with token.
createUserAndToken(Iterable<CommunicationTokenScope>) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Creates a new CommunicationUserIdentifier with token.
createUserAndToken(Iterable<CommunicationTokenScope>, Duration) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Creates a new CommunicationUserIdentifier with token.
createUserAndToken(Iterable<CommunicationTokenScope>, Duration) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Creates a new CommunicationUserIdentifier with token.
createUserAndTokenWithResponse(Iterable<CommunicationTokenScope>) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Creates a new CommunicationUserIdentifier with token with response.
createUserAndTokenWithResponse(Iterable<CommunicationTokenScope>, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Creates a new CommunicationUserIdentifier with token with response.
createUserAndTokenWithResponse(Iterable<CommunicationTokenScope>, Duration) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Creates a new CommunicationUserIdentifier with token with response.
createUserAndTokenWithResponse(Iterable<CommunicationTokenScope>, Duration, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Creates a new CommunicationUserIdentifier with token with response.
createUserWithResponse() - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Creates a new CommunicationUserIdentifier with response.
createUserWithResponse(Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Creates a new CommunicationUserIdentifier with response.
Creating a new user - Search tag in Overview
Section
credential(AzureKeyCredential) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the AzureKeyCredential used to authenticate HTTP requests.
credential(TokenCredential) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the TokenCredential used to authorize requests sent to the service.

D

deleteUser(CommunicationUserIdentifier) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data.
deleteUser(CommunicationUserIdentifier) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data.
deleteUserWithResponse(CommunicationUserIdentifier) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data with response.
deleteUserWithResponse(CommunicationUserIdentifier, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data with response.
Deleting a user - Search tag in Overview
Section

E

endpoint(String) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Set endpoint of the service
Examples - Search tag in Overview
Section
Exchanging Azure AD access token of a Teams User for a Communication Identity access token - Search tag in Overview
Section

F

fromJson(JsonReader) - Static method in class com.azure.communication.identity.models.GetTokenForTeamsUserOptions
Reads an instance of TeamsUserExchangeTokenRequest from the JsonReader.
fromString(String) - Static method in class com.azure.communication.identity.models.CommunicationTokenScope
Creates or finds a CommunicationTokenScope from its string representation.

G

getClientId() - Method in class com.azure.communication.identity.models.GetTokenForTeamsUserOptions
Gets the Client ID of an Azure AD application.
getCode() - Method in class com.azure.communication.identity.models.IdentityError
Get the code property: The error code.
getDetails() - Method in class com.azure.communication.identity.models.IdentityError
Get the details property: Further details about specific errors that led to this error.
getLatest() - Static method in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Gets the latest service version supported by this client library
getMessage() - Method in class com.azure.communication.identity.models.IdentityError
Get the message property: The error message.
getTarget() - Method in class com.azure.communication.identity.models.IdentityError
Get the target property: The error target.
getTeamsUserAadToken() - Method in class com.azure.communication.identity.models.GetTokenForTeamsUserOptions
Gets the Azure AD access token of a Teams User.
Getting a token for an existing user - Search tag in Overview
Section
Getting started - Search tag in Overview
Section
getToken(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getToken(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getToken(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>, Duration) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getToken(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>, Duration) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getTokenForTeamsUser(GetTokenForTeamsUserOptions) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token.
getTokenForTeamsUser(GetTokenForTeamsUserOptions) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token.
GetTokenForTeamsUserOptions - Class in com.azure.communication.identity.models
GetTokenForTeamsUserOptions(String, String, String) - Constructor for class com.azure.communication.identity.models.GetTokenForTeamsUserOptions
getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token.
getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token.
getTokenWithResponse(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getTokenWithResponse(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getTokenWithResponse(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>, Duration) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getTokenWithResponse(CommunicationUserIdentifier, Iterable<CommunicationTokenScope>, Duration, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Gets a Communication Identity access token for a CommunicationUserIdentifier.
getUser() - Method in class com.azure.communication.identity.models.CommunicationUserIdentifierAndToken
Get the communicationUser property: A Communication User Identifier.
getUserObjectId() - Method in class com.azure.communication.identity.models.GetTokenForTeamsUserOptions
Gets the Object ID of an Azure AD user (Teams User).
getUserToken() - Method in class com.azure.communication.identity.models.CommunicationUserIdentifierAndToken
Get the userToken property: A user token.
getValue() - Method in exception class com.azure.communication.identity.models.IdentityErrorResponseException
 
getVersion() - Method in enum com.azure.communication.identity.CommunicationIdentityServiceVersion

H

httpClient(HttpClient) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the HttpClient to use for sending and receiving requests to and from the service.
httpLogOptions(HttpLogOptions) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the logging configuration to use when sending and receiving requests to and from the service.

I

IdentityError - Class in com.azure.communication.identity.models
The Phone Number Services error.
IdentityError(String, String, String, List<IdentityError>) - Constructor for class com.azure.communication.identity.models.IdentityError
Constructs a new IdentityError
IdentityErrorResponseException - Exception Class in com.azure.communication.identity.models
Exception thrown on phone number specific errors
IdentityErrorResponseException(String, HttpResponse, IdentityError) - Constructor for exception class com.azure.communication.identity.models.IdentityErrorResponseException
Initializes a new instance of the IdentityErrorResponseException class.
Include direct dependency - Search tag in Overview
Section
Include the BOM file - Search tag in Overview
Section
Include the package - Search tag in Overview
Section

K

Key concepts - Search tag in Overview
Section

N

Next steps - Search tag in Overview
Section

P

pipeline(HttpPipeline) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the HttpPipeline to use for the service client.
Prerequisites - Search tag in Overview
Section

R

retryOptions(RetryOptions) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the RetryOptions for all the requests made through the client.
retryPolicy(RetryPolicy) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the RetryPolicy that is used when each request is sent.
revokeTokens(CommunicationUserIdentifier) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Revokes all the tokens created for an identifier.
revokeTokens(CommunicationUserIdentifier) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Revokes all the tokens created for an identifier.
revokeTokensWithResponse(CommunicationUserIdentifier) - Method in class com.azure.communication.identity.CommunicationIdentityAsyncClient
Revokes all the tokens created for an identifier with response.
revokeTokensWithResponse(CommunicationUserIdentifier, Context) - Method in class com.azure.communication.identity.CommunicationIdentityClient
Revokes all the tokens created for a user before a specific date.
Revoking all tokens for an existing user - Search tag in Overview
Section

S

serviceVersion(CommunicationIdentityServiceVersion) - Method in class com.azure.communication.identity.CommunicationIdentityClientBuilder
Sets the CommunicationIdentityServiceVersion that is used when making API requests.

T

toJson(JsonWriter) - Method in class com.azure.communication.identity.models.GetTokenForTeamsUserOptions
 
Troubleshooting - Search tag in Overview
Section

V

V2021_03_07 - Enum constant in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Service version 2021-03-07.
V2022_06_01 - Enum constant in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Service version 2022-06-01.
V2022_10_01 - Enum constant in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Service version 2022-10-01.
V2023_10_01 - Enum constant in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Service version 2023-10-01.
valueOf(String) - Static method in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.azure.communication.identity.CommunicationIdentityServiceVersion
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in class com.azure.communication.identity.models.CommunicationTokenScope
Gets known CommunicationTokenScope values.
VOIP - Static variable in class com.azure.communication.identity.models.CommunicationTokenScope
Use this for full access to Calling APIs.
VOIP_JOIN - Static variable in class com.azure.communication.identity.models.CommunicationTokenScope
Access to Calling APIs but without the authorization to start new calls.
A B C D E F G H I K N P R S T V 
All Classes and Interfaces|All Packages|Serialized Form