207 строки
21 KiB
YAML
207 строки
21 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.identity.CommunicationIdentityClient"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient"
|
|
name: "CommunicationIdentityClient"
|
|
nameWithType: "CommunicationIdentityClient"
|
|
summary: "Synchronous client interface for Azure Communication Service Identity operations"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedMembers:
|
|
- "java.lang.Object.clone()"
|
|
- "java.lang.Object.equals(java.lang.Object)"
|
|
- "java.lang.Object.finalize()"
|
|
- "java.lang.Object.getClass()"
|
|
- "java.lang.Object.hashCode()"
|
|
- "java.lang.Object.notify()"
|
|
- "java.lang.Object.notifyAll()"
|
|
- "java.lang.Object.toString()"
|
|
- "java.lang.Object.wait()"
|
|
- "java.lang.Object.wait(long)"
|
|
- "java.lang.Object.wait(long,int)"
|
|
syntax: "public final class CommunicationIdentityClient"
|
|
methods:
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.createUser()"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.createUser()"
|
|
name: "createUser()"
|
|
nameWithType: "CommunicationIdentityClient.createUser()"
|
|
summary: "Creates a new Communication<wbr>User<wbr>Identifier."
|
|
syntax: "public CommunicationUserIdentifier createUser()"
|
|
desc: "Creates a new CommunicationUserIdentifier."
|
|
returns:
|
|
description: "The created Communication User."
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.createUserAndToken(java.lang.Iterable<com.azure.communication.identity.models.CommunicationTokenScope>)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.createUserAndToken(Iterable<CommunicationTokenScope> scopes)"
|
|
name: "createUserAndToken(Iterable<CommunicationTokenScope> scopes)"
|
|
nameWithType: "CommunicationIdentityClient.createUserAndToken(Iterable<CommunicationTokenScope> scopes)"
|
|
summary: "Creates a new Communication<wbr>User<wbr>Identifier with token."
|
|
parameters:
|
|
- description: "The list of scopes for the token."
|
|
name: "scopes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.communication.identity.models.CommunicationTokenScope?alt=com.azure.communication.identity.models.CommunicationTokenScope&text=CommunicationTokenScope\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public CommunicationUserIdentifierAndToken createUserAndToken(Iterable<CommunicationTokenScope> scopes)"
|
|
desc: "Creates a new CommunicationUserIdentifier with token."
|
|
returns:
|
|
description: "The created communication user and token."
|
|
type: "<xref href=\"com.azure.communication.identity.models.CommunicationUserIdentifierAndToken?alt=com.azure.communication.identity.models.CommunicationUserIdentifierAndToken&text=CommunicationUserIdentifierAndToken\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.createUserAndTokenWithResponse(java.lang.Iterable<com.azure.communication.identity.models.CommunicationTokenScope>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.createUserAndTokenWithResponse(Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
name: "createUserAndTokenWithResponse(Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
nameWithType: "CommunicationIdentityClient.createUserAndTokenWithResponse(Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
summary: "Creates a new Communication<wbr>User<wbr>Identifier with token with response."
|
|
parameters:
|
|
- description: "The list of scopes for the token."
|
|
name: "scopes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.communication.identity.models.CommunicationTokenScope?alt=com.azure.communication.identity.models.CommunicationTokenScope&text=CommunicationTokenScope\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "A <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> representing the request context."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<CommunicationUserIdentifierAndToken> createUserAndTokenWithResponse(Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
desc: "Creates a new CommunicationUserIdentifier with token with response."
|
|
returns:
|
|
description: "The created communication user and token with response."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.identity.models.CommunicationUserIdentifierAndToken?alt=com.azure.communication.identity.models.CommunicationUserIdentifierAndToken&text=CommunicationUserIdentifierAndToken\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.createUserWithResponse(com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.createUserWithResponse(Context context)"
|
|
name: "createUserWithResponse(Context context)"
|
|
nameWithType: "CommunicationIdentityClient.createUserWithResponse(Context context)"
|
|
summary: "Creates a new Communication<wbr>User<wbr>Identifier with response."
|
|
parameters:
|
|
- description: "A <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> representing the request context."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<CommunicationUserIdentifier> createUserWithResponse(Context context)"
|
|
desc: "Creates a new CommunicationUserIdentifier with response."
|
|
returns:
|
|
description: "The created Communication User."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.deleteUser(com.azure.communication.common.CommunicationUserIdentifier)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.deleteUser(CommunicationUserIdentifier communicationUser)"
|
|
name: "deleteUser(CommunicationUserIdentifier communicationUser)"
|
|
nameWithType: "CommunicationIdentityClient.deleteUser(CommunicationUserIdentifier communicationUser)"
|
|
summary: "Deletes a Communication<wbr>User<wbr>Identifier, revokes its tokens and deletes its data."
|
|
parameters:
|
|
- description: "The user to be deleted."
|
|
name: "communicationUser"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void deleteUser(CommunicationUserIdentifier communicationUser)"
|
|
desc: "Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data."
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.deleteUserWithResponse(com.azure.communication.common.CommunicationUserIdentifier,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.deleteUserWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
name: "deleteUserWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
nameWithType: "CommunicationIdentityClient.deleteUserWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
summary: "Deletes a Communication<wbr>User<wbr>Identifier, revokes its tokens and deletes its data with response."
|
|
parameters:
|
|
- description: "The user to be deleted."
|
|
name: "communicationUser"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> representing the request context."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteUserWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
desc: "Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data with response."
|
|
returns:
|
|
description: "The response with void."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.getToken(com.azure.communication.common.CommunicationUserIdentifier,java.lang.Iterable<com.azure.communication.identity.models.CommunicationTokenScope>)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.getToken(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes)"
|
|
name: "getToken(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes)"
|
|
nameWithType: "CommunicationIdentityClient.getToken(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes)"
|
|
summary: "Gets a token for an identity."
|
|
parameters:
|
|
- description: "The user to be issued tokens."
|
|
name: "communicationUser"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The scopes that the token should have."
|
|
name: "scopes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.communication.identity.models.CommunicationTokenScope?alt=com.azure.communication.identity.models.CommunicationTokenScope&text=CommunicationTokenScope\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public AccessToken getToken(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes)"
|
|
desc: "Gets a token for an identity."
|
|
returns:
|
|
description: "the token."
|
|
type: "<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.getTokenForTeamsUser(com.azure.communication.identity.models.GetTokenForTeamsUserOptions)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.getTokenForTeamsUser(GetTokenForTeamsUserOptions options)"
|
|
name: "getTokenForTeamsUser(GetTokenForTeamsUserOptions options)"
|
|
nameWithType: "CommunicationIdentityClient.getTokenForTeamsUser(GetTokenForTeamsUserOptions options)"
|
|
summary: "Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.communication.identity.models.GetTokenForTeamsUserOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GetTokenForTeamsUserOptions\"></xref> request options used to exchange an Azure AD access token of a Teams User for a new Communication Identity access token."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.communication.identity.models.GetTokenForTeamsUserOptions?alt=com.azure.communication.identity.models.GetTokenForTeamsUserOptions&text=GetTokenForTeamsUserOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AccessToken getTokenForTeamsUser(GetTokenForTeamsUserOptions options)"
|
|
desc: "Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token."
|
|
returns:
|
|
description: "Communication Identity access token."
|
|
type: "<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.getTokenForTeamsUserWithResponse(com.azure.communication.identity.models.GetTokenForTeamsUserOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions options, Context context)"
|
|
name: "getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions options, Context context)"
|
|
nameWithType: "CommunicationIdentityClient.getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions options, Context context)"
|
|
summary: "Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.communication.identity.models.GetTokenForTeamsUserOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GetTokenForTeamsUserOptions\"></xref> request options used to exchange an Azure AD access token of a Teams User for a new Communication Identity access token."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.communication.identity.models.GetTokenForTeamsUserOptions?alt=com.azure.communication.identity.models.GetTokenForTeamsUserOptions&text=GetTokenForTeamsUserOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the context of the request. Can also be null or\n Context.NONE."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<AccessToken> getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions options, Context context)"
|
|
desc: "Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token."
|
|
returns:
|
|
description: "Communication Identity access token with response."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.getTokenWithResponse(com.azure.communication.common.CommunicationUserIdentifier,java.lang.Iterable<com.azure.communication.identity.models.CommunicationTokenScope>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.getTokenWithResponse(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
name: "getTokenWithResponse(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
nameWithType: "CommunicationIdentityClient.getTokenWithResponse(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
summary: "Gets a token for an identity."
|
|
parameters:
|
|
- description: "The CommunicationUser from whom to issue a token."
|
|
name: "communicationUser"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The scopes that the token should have."
|
|
name: "scopes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.communication.identity.models.CommunicationTokenScope?alt=com.azure.communication.identity.models.CommunicationTokenScope&text=CommunicationTokenScope\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the context of the request. Can also be null or\n Context.NONE."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<AccessToken> getTokenWithResponse(CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes, Context context)"
|
|
desc: "Gets a token for an identity."
|
|
returns:
|
|
description: "the token with response."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.revokeTokens(com.azure.communication.common.CommunicationUserIdentifier)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.revokeTokens(CommunicationUserIdentifier communicationUser)"
|
|
name: "revokeTokens(CommunicationUserIdentifier communicationUser)"
|
|
nameWithType: "CommunicationIdentityClient.revokeTokens(CommunicationUserIdentifier communicationUser)"
|
|
summary: "Revokes all the tokens created for an identifier."
|
|
parameters:
|
|
- description: "The user to be revoked token."
|
|
name: "communicationUser"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void revokeTokens(CommunicationUserIdentifier communicationUser)"
|
|
desc: "Revokes all the tokens created for an identifier."
|
|
- uid: "com.azure.communication.identity.CommunicationIdentityClient.revokeTokensWithResponse(com.azure.communication.common.CommunicationUserIdentifier,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.identity.CommunicationIdentityClient.revokeTokensWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
name: "revokeTokensWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
nameWithType: "CommunicationIdentityClient.revokeTokensWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
summary: "Revokes all the tokens created for a user before a specific date."
|
|
parameters:
|
|
- description: "The user to be revoked token."
|
|
name: "communicationUser"
|
|
type: "<xref href=\"com.azure.communication.common.CommunicationUserIdentifier?alt=com.azure.communication.common.CommunicationUserIdentifier&text=CommunicationUserIdentifier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the context of the request. Can also be null or\n Context.NONE."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> revokeTokensWithResponse(CommunicationUserIdentifier communicationUser, Context context)"
|
|
desc: "Revokes all the tokens created for a user before a specific date."
|
|
returns:
|
|
description: "The response with void."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
type: "class"
|
|
desc: "Synchronous client interface for Azure Communication Service Identity operations\n\n**Instantiating a synchronous Azure Communication Service Identity Client**\n\n```java\n// You can find your endpoint and access key from your resource in the Azure Portal\n String endpoint = \"https://<RESOURCE_NAME>.communication.azure.com\";\n AzureKeyCredential keyCredential = new AzureKeyCredential(\"<access-key>\");\n\n CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()\n .endpoint(endpoint)\n .credential(keyCredential)\n .buildClient();\n```\n\nView <xref uid=\"com.azure.communication.identity.CommunicationIdentityClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> for additional ways to construct the client."
|
|
metadata: {}
|
|
package: "com.azure.communication.identity"
|
|
artifact: com.azure:azure-communication-identity:1.3.1
|