CommunicationTokenScope Class

Package:
com.azure.communication.identity.models
Maven Artifact:
com.azure:azure-communication-identity:1.6.10

public final class CommunicationTokenScope
extends ExpandableStringEnum<CommunicationTokenScope>

List of scopes for an access token.

Field Summary

Modifier and Type Field and Description
static final CommunicationTokenScope CHAT

Use this for full access to Chat APIs.
static final CommunicationTokenScope CHAT_JOIN

Access to Chat APIs but without the authorization to create, delete or update chat threads.
static final CommunicationTokenScope CHAT_JOIN_LIMITED

A more limited version of chat.join that doesn't allow to add or remove participants.
static final CommunicationTokenScope VOIP

Use this for full access to Calling APIs.
static final CommunicationTokenScope VOIP_JOIN

Access to Calling APIs but without the authorization to start new calls.

Constructor Summary

Constructor Description
CommunicationTokenScope()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of CommunicationTokenScope value.

Method Summary

Modifier and Type Method and Description
static CommunicationTokenScope fromString(String name)

Creates or finds a CommunicationTokenScope from its string representation.
static Collection<CommunicationTokenScope> values()

Gets known CommunicationTokenScope values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

CHAT

public static final CommunicationTokenScope CHAT

Use this for full access to Chat APIs.

CHAT_JOIN

public static final CommunicationTokenScope CHAT_JOIN

Access to Chat APIs but without the authorization to create, delete or update chat threads.

CHAT_JOIN_LIMITED

public static final CommunicationTokenScope CHAT_JOIN_LIMITED

A more limited version of chat.join that doesn't allow to add or remove participants. Use this scope when the token bearer is not fully trusted, for example in guest scenarios.

VOIP

public static final CommunicationTokenScope VOIP

Use this for full access to Calling APIs.

VOIP_JOIN

public static final CommunicationTokenScope VOIP_JOIN

Access to Calling APIs but without the authorization to start new calls.

Constructor Details

CommunicationTokenScope

@Deprecated
public CommunicationTokenScope()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of CommunicationTokenScope value.

Method Details

fromString

public static CommunicationTokenScope fromString(String name)

Creates or finds a CommunicationTokenScope from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding CommunicationTokenScope.

values

public static Collection<CommunicationTokenScope> values()

Gets known CommunicationTokenScope values.

Returns:

known CommunicationTokenScope values.

Applies to