Reconocimiento de los tipos de identificadores

Usuario de Microsoft Teams

La interfaz MicrosoftTeamsUserIdentifier representa a un usuario de Teams con su identificador de objeto de usuario de Microsoft Entra. Puedes recuperar el identificador de objeto de usuario de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph. Como alternativa, puedes encontrar el identificador como la notificación oid en un token de Microsoft Entra o en un token de acceso de Microsoft Entra después de que el usuario haya iniciado sesión y adquirido un token.

Uso básico

// get the Teams user's ID from Graph APIs if only the email is known
const user = await graphClient.api("/users/bob@contoso.com").get();

// create an identifier
const teamsUser = { microsoftTeamsUserId: user.id };

// if you're not operating in the public cloud, you must also pass the right Cloud type.
const gcchTeamsUser = { microsoftTeamsUserId: userId, cloud: "gcch" };

Referencia de la API

Número de teléfono

La interfaz PhoneNumberIdentifier representa un número de teléfono. El servicio supone que los números de teléfono tienen formato E.164.

Uso básico

// create an identifier
const phoneNumber = { phoneNumber: "+112345556789" };

Referencia de la API

Aplicación de Microsoft Teams

La interfaz MicrosoftTeamsAppIdentifier representa un bot de las aplicaciones de voz de Teams, como Cola de llamadas y Operador automático con su identificador de objeto de bot de Microsoft Entra. Las aplicaciones de Teams deben configurarse con una cuenta de recurso. Puedes recuperar el identificador de objeto de bot de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph.

Uso básico

// Get the Microsoft Teams App's ID from Graph APIs
const users = await graphClient.api("/users")
                    .filter(filterConditions)
                    .select('displayName,id')
                    .get();
//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
const bot = getBotFromUsers(users);
// Create an identifier
const teamsAppIdentifier = { teamsAppId: bot.id };

// If you're not operating in the public cloud, you must also pass the right Cloud type.
const gcchTeamsAppIdentifier = { teamsAppId: id, cloud: "gcch" };

Referencia de la API

Unknown

La interfaz UnknownIdentifier existe para futuras correcciones, y es posible que se lo encuentre cuando esté en una versión anterior del SDK y se haya introducido recientemente un nuevo tipo de identificador. Cualquier identificador desconocido del servicio se deserializará en el UnknownIdentifier del SDK.

Uso básico

// create an identifier
const unknownId = { id: "a raw id that originated in the service" };

Referencia de la API

Cómo controlar la interfaz base de `CommunicationIdentifier`

Mientras construye identificadores para un tipo concreto que se pasa al SDK, el SDK devuelve un CommunicationIdentifierKind, que es una unión discriminada. Es fácil restringir a un tipo concreto y se recomienda una instrucción de cambio de mayúsculas y minúsculas con coincidencia de patrones:

switch (communicationIdentifier.kind)
{
    case "communicationUser":
        // TypeScript has narrowed communicationIdentifier to be a CommunicationUserKind
        console.log(`Communication user: ${communicationIdentifier.communicationUserId}`);
        break;
    case "microsoftTeamsUser":
        // narrowed to MicrosoftTeamsUserKind
        console.log(`Teams user: ${communicationIdentifier.microsoftTeamsUserId}`);
        break;
    case "phoneNumber":
         // narrowed to PhoneNumberKind
        console.log(`Phone number: ${communicationIdentifier.phoneNumber}`);
        break;
    case "unknown":
         // narrowed to UnknownIdentifierKind
        console.log(`Unknown: ${communicationIdentifier.id}`);
        break;
    case "microsoftBot":
        // narrowed to MicrosoftBotIdentifier
        console.log(`Microsoft bot: ${communicationIdentifier.botId}`);
        break;
    default:
        // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
        break;
}

Las interfaces de identificador se han diseñado para que no tenga que especificar kind para reducir el nivel de detalle, y la unión discriminante con la propiedad kind solo se usa cuando se devuelve desde el SDK. Sin embargo, si necesita traducir un identificador a su tipo de unión discriminante correspondiente, puede usar este asistente:

const identifierKind = getIdentifierKind(identifier); // now you can switch-case on the kind

Representación de ID sin formato

A veces es necesario serializar un identificador en una cadena plana. Por ejemplo, si desea almacenar el identificador en una tabla de base de datos o si desea usarlo como parámetro de dirección URL.

Para ello, los identificadores tienen otra representación denominada RawId. Un identificador siempre se puede traducir a su identificador sin procesar correspondiente y siempre se puede convertir un identificador sin procesar válido en un identificador.

Desde azure-communication-common@2.1.0 el SDK ayuda con la conversión:

// get an identifier's raw Id
const rawId = getIdentifierRawId(communicationIdentifier);

// create an identifier from a given raw Id
const identifier = createIdentifierFromRawId(rawId);

Un identificador sin procesar no válido simplemente se convertirá en un UnknownIdentifier en el SDK y cualquier validación solo se produce en el lado del servicio.

Usuario de comunicación

CommunicationUserIdentifier representa una identidad de usuario que se creó mediante el SDK de identidad o la API de REST. Es el único identificador que se usa si la aplicación no usa las características de interoperabilidad o telefonía de Microsoft Teams.

Uso básico

// at some point you will have created a new user identity in your trusted service
CommunicationUserIdentifier newUser = await identityClient.CreateUser();

// and then send newUser.Id down to your client application
// where you can again create an identifier for the user
var sameUser = new CommunicationUserIdentifier(newUserId);

Referencia de la API

Usuario de Microsoft Teams

La MicrosoftTeamsUserIdentifier representa un usuario de Teams con su identificador de objeto de usuario de Microsoft Entra. Puedes recuperar el identificador de objeto de usuario de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph. Como alternativa, puedes encontrar el identificador como la notificación oid en un token de Microsoft Entra o en un token de acceso de Microsoft Entra después de que el usuario haya iniciado sesión y adquirido un token.

Uso básico

// get the Teams user's ID from Graph APIs if only the email is known
var user = await graphClient.Users["bob@contoso.com"]
    .Request()
    .GetAsync();

// create an identifier
var teamsUser = new MicrosoftTeamsUserIdentifier(user.Id);

// if you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsUser = new MicrosoftTeamsUserIdentifier(userId: userId, cloud: CommunicationCloudEnvironment.Gcch);

Referencia de la API

Número de teléfono

PhoneNumberIdentifier representa un número de teléfono. El servicio supone que los números de teléfono tienen formato E.164.

Uso básico

// create an identifier
var phoneNumber = new PhoneNumberIdentifier("+112345556789");

Referencia de la API

Aplicación de Microsoft Teams

La interfaz MicrosoftTeamsAppIdentifier representa un bot de las aplicaciones de voz de Teams, como Cola de llamadas y Operador automático con su identificador de objeto de bot de Microsoft Entra. Las aplicaciones de Teams deben configurarse con una cuenta de recurso. Puedes recuperar el identificador de objeto de bot de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph.

Uso básico

// Get the Microsoft Teams App's ID from Graph APIs
var users = await graphClient.Users.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","id" };
	requestConfiguration.QueryParameters.Filter = filterConditions;
});

// Here we assume that you have a function GetBotFromUsers that gets the bot from the returned response
var bot = GetBotFromUsers(users);

// Create an identifier
var teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.Id);

// If you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.Id, CommunicationCloudEnvironment.Gcch);

Referencia de la API

Unknown

UnknownIdentifier existe para futuras correcciones, y es posible que se lo encuentre cuando esté en una versión anterior del SDK y se haya introducido recientemente un nuevo tipo de identificador. Cualquier identificador desconocido del servicio se deserializará en el UnknownIdentifier del SDK.

Uso básico

// create an identifier
var unknown = new UnknownIdentifier("a raw id that originated in the service");

Referencia de la API

Cómo controlar la clase base `CommunicationIdentifier`

Mientras construye identificadores para un tipo concreto que se pasa al SDK, el SDK devuelve el protocolo CommunicationIdentifier. Es fácil reducir la conversión a un tipo concreto, y se recomienda una instrucción con cambio de mayúsculas y minúsculas con coincidencia de patrones:

switch (communicationIdentifier)
{
    case CommunicationUserIdentifier communicationUser:
        Console.WriteLine($"Communication user: {communicationUser.Id}");
        break;
    case MicrosoftTeamsUserIdentifier teamsUser:
        Console.WriteLine($"Teams user: {teamsUser.UserId}");
        break;
    case PhoneNumberIdentifier phoneNumber:
        Console.WriteLine($"Phone number: {phoneNumber.PhoneNumber}");
        break;
    case MicrosoftBotIdentifier bot:
        Console.WriteLine($"Microsoft bot: {bot.BotId}");
        break;
    case UnknownIdentifier unknown:
        Console.WriteLine($"Unknown: {unknown.Id}");
        break;
    default:
        // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
        break;
}

Representación de ID sin formato

A veces es necesario serializar un identificador en una cadena plana. Por ejemplo, si desea almacenar el identificador en una tabla de base de datos o si desea usarlo como parámetro de dirección URL.

Para ello, los identificadores tienen otra representación denominada RawId. Un identificador siempre se puede traducir a su identificador sin procesar correspondiente y siempre se puede convertir un identificador sin procesar válido en un identificador.

Desde Azure.Communication.Common 1.2.0 el SDK ayuda con la conversión:

// get an identifier's raw Id
string rawId = communicationIdentifier.RawId;

// create an identifier from a given raw Id
CommunicationIdentifier identifier = CommunicationIdentifier.FromRawId(rawId);

Un identificador sin procesar no válido simplemente se convertirá en un UnknownIdentifier en el SDK y cualquier validación solo se produce en el lado del servicio.

Usuario de comunicación

CommunicationUserIdentifier representa una identidad de usuario que se creó mediante el SDK de identidad o la API de REST. Es el único identificador que se usa si la aplicación no usa las características de interoperabilidad o telefonía de Microsoft Teams.

Uso básico

# at some point you will have created a new user identity in your trusted service
new_user = identity_client.create_user()

# and then send new_user.properties['id'] down to your client application
# where you can again create an identifier for the user
same_user = CommunicationUserIdentifier(new_user_id)

Referencia de la API

Usuario de Microsoft Teams

La MicrosoftTeamsUserIdentifier representa un usuario de Teams con su identificador de objeto de usuario de Microsoft Entra. Puedes recuperar el identificador de objeto de usuario de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph. Como alternativa, puedes encontrar el identificador como la notificación oid en un token de Microsoft Entra o en un token de acceso de Microsoft Entra después de que el usuario haya iniciado sesión y adquirido un token.

Uso básico

# get the Teams user's ID from Graph APIs if only the email is known
user_id = graph_client.get("/users/bob@contoso.com").json().get("id");

# create an identifier
teams_user = MicrosoftTeamsUserIdentifier(user_id)

# if you're not operating in the public cloud, you must also pass the right Cloud type.
gcch_teams_user = MicrosoftTeamsUserIdentifier(user_id, cloud=CommunicationCloudEnvironment.GCCH)

Referencia de la API

Número de teléfono

PhoneNumberIdentifier representa un número de teléfono. El servicio supone que los números de teléfono tienen formato E.164.

Uso básico

# create an identifier
phone_number = PhoneNumberIdentifier("+112345556789")

Referencia de la API

Aplicación de Microsoft Teams

La interfaz MicrosoftTeamsAppIdentifier representa un bot de las aplicaciones de voz de Teams, como Cola de llamadas y Operador automático con su identificador de objeto de bot de Microsoft Entra. Las aplicaciones de Teams deben configurarse con una cuenta de recurso. Puedes recuperar el identificador de objeto de bot de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph.

Uso básico

# Get the Microsoft Teams App's ID from Graph APIs
users = graph_client.get("/users").json()

# Here we assume that you have a function get_bot_from_users that gets the bot from the returned response
bot = get_bot_from_users(users);

# Create an identifier
teams_app_identifier = MicrosoftTeamsAppIdentifier(app_id=bot.get("id"))

# If you're not operating in the public cloud, you must also pass the right Cloud type.
gcch_teams_app_identifier = MicrosoftTeamsAppIdentifier(
            app_id=bot.get("id"),
            cloud=CommunicationCloudEnvironment.GCCH
        )

Referencia de la API

Unknown

UnknownIdentifier existe para futuras correcciones, y es posible que se lo encuentre cuando esté en una versión anterior del SDK y se haya introducido recientemente un nuevo tipo de identificador. Cualquier identificador desconocido del servicio se deserializará en el UnknownIdentifier del SDK.

Uso básico

# create an identifier
unknown = UnknownIdentifier("a raw id that originated in the service")

Referencia de la API

Cómo controlar la clase base `CommunicationIdentifier`

Mientras construye identificadores para un tipo concreto que se pasa al SDK, el SDK devuelve el protocolo CommunicationIdentifier. Las clases de identificador concretas son solo el protocolo CommunicationIdentifier junto con un diccionario con tipo denominado properties. Por lo tanto, puede usar la coincidencia de patrones en la variable de instancia kind del protocolo para traducir al tipo concreto:

match communication_identifier.kind:
    case CommunicationIdentifierKind.COMMUNICATION_USER:
        print(f"Communication user: {communication_identifier.properties['id']}")
    case CommunicationIdentifierKind.MICROSOFT_TEAMS_USER:
        print(f"Teams user: {communication_identifier.properties['user_id']}")
    case CommunicationIdentifierKind.PHONE_NUMBER:
        print(f"Phone number: {communication_identifier.properties['value']}")
    case CommunicationIdentifierKind.MICROSOFT_BOT:
        print(f"Microsoft bot: {communication_identifier.properties['bot_id']}")
    case CommunicationIdentifierKind.UNKNOWN:
        print(f"Unknown: {communication_identifier.raw_id}")
    case _:
        # be careful here whether you want to throw because a new SDK version
        # can introduce new identifier types

Representación de ID sin formato

A veces es necesario serializar un identificador en una cadena plana. Por ejemplo, si desea almacenar el identificador en una tabla de base de datos o si desea usarlo como parámetro de dirección URL.

Para ello, los identificadores tienen otra representación denominada RawId. Un identificador siempre se puede traducir a su identificador sin procesar correspondiente y siempre se puede convertir un identificador sin procesar válido en un identificador.

El SDK ayuda con la conversión:

# get an identifier's raw Id
raw_id = communication_identifier.raw_id

# create an identifier from a given raw Id
identifier = identifier_from_raw_id(raw_id)

Un identificador sin procesar no válido simplemente se convertirá en un UnknownIdentifier en el SDK y cualquier validación solo se produce en el lado del servicio.

Usuario de comunicación

CommunicationUserIdentifier representa una identidad de usuario que se creó mediante el SDK de identidad o la API de REST. Es el único identificador que se usa si la aplicación no usa las características de interoperabilidad o telefonía de Microsoft Teams.

Uso básico

// at some point you will have created a new user identity in your trusted service
CommunicationUserIdentifier newUser = identityClient.CreateUser();

// and then send newUser.getId() down to your client application
// where you can again create an identifier for the user
var sameUser = new CommunicationUserIdentifier(newUserId);

Referencia de la API

Usuario de Microsoft Teams

La MicrosoftTeamsUserIdentifier representa un usuario de Teams con su identificador de objeto de usuario de Microsoft Entra. Puedes recuperar el identificador de objeto de usuario de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph. Como alternativa, puedes encontrar el identificador como la notificación oid en un token de Microsoft Entra o en un token de acceso de Microsoft Entra después de que el usuario haya iniciado sesión y adquirido un token.

Uso básico

// get the Teams user's ID from Graph APIs if only the email is known
var user = graphClient.users("bob@contoso.com")
    .buildRequest()
    .get();

// create an identifier
var teamsUser = new MicrosoftTeamsUserIdentifier(user.id);

// if you're not operating in the public cloud, you must also set the right Cloud type.
var gcchTeamsUser = new MicrosoftTeamsUserIdentifier(userId).setCloudEnvironment(CommunicationCloudEnvironment.GCCH);

Referencia de la API

Número de teléfono

PhoneNumberIdentifier representa un número de teléfono. El servicio supone que los números de teléfono tienen formato E.164.

Uso básico

// create an identifier
var phoneNumber = new PhoneNumberIdentifier("+112345556789");

Referencia de la API

Aplicación de Microsoft Teams

La interfaz MicrosoftTeamsAppIdentifier representa un bot de las aplicaciones de voz de Teams, como Cola de llamadas y Operador automático con su identificador de objeto de bot de Microsoft Entra. Las aplicaciones de Teams deben configurarse con una cuenta de recurso. Puedes recuperar el identificador de objeto de bot de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph.

Uso básico

// Get the Microsoft Teams App's ID from Graph APIs
var user = graphClient.users()
	.buildRequest()
	.filter(filterConditions)
	.select("displayName,id")
	.get();

//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
var bot = getBotFromUsers(users);

// Create an identifier
var teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id);

// If you're not operating in the public cloud, you must also pass the right Cloud type.
var gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id, CommunicationCloudEnvironment.GCCH);

Referencia de la API

Unknown

UnknownIdentifier existe para futuras correcciones, y es posible que se lo encuentre cuando esté en una versión anterior del SDK y se haya introducido recientemente un nuevo tipo de identificador. Cualquier identificador desconocido del servicio se deserializará en el UnknownIdentifier del SDK.

Uso básico

// create an identifier
var unknown = new UnknownIdentifier("a raw id that originated in the service");

Referencia de la API

Cómo controlar la clase base `CommunicationIdentifier`

Mientras construye identificadores para un tipo concreto que se pasa al SDK, el SDK devuelve el resumen CommunicationIdentifier. Puede revertir a un tipo concreto:

if (communicationIdentifier instanceof CommunicationUserIdentifier) {
    System.out.println("Communication user: " + ((CommunicationUserIdentifier)communicationIdentifier).getId());
}
else if (communicationIdentifier instanceof MicrosoftTeamsUserIdentifier) {
    System.out.println("Teams user: " + ((MicrosoftTeamsUserIdentifier)communicationIdentifier).getUserId());
}
else if (communicationIdentifier instanceof PhoneNumberIdentifier) {
    System.out.println("Phone number: " + ((PhoneNumberIdentifier)communicationIdentifier).getPhoneNumber());
}
else if (communicationIdentifier instanceof MicrosoftBotIdentifier) {
    Log.i(tag, "Microsoft bot: " + ((MicrosoftBotIdentifier)communicationIdentifier).getBotId());
}
else if (communicationIdentifier instanceof UnknownIdentifier) {
    System.out.println("Unkown user: " + ((UnknownIdentifier)communicationIdentifier).getId());
}
else {
    // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
}

Representación de ID sin formato

A veces es necesario serializar un identificador en una cadena plana. Por ejemplo, si desea almacenar el identificador en una tabla de base de datos o si desea usarlo como parámetro de dirección URL.

Para ello, los identificadores tienen otra representación denominada RawId. Un identificador siempre se puede traducir a su identificador sin procesar correspondiente y siempre se puede convertir un identificador sin procesar válido en un identificador.

Desde azure-communication-common 1.2.0 el SDK ayuda con la conversión:

// get an identifier's raw Id
String rawId = communicationIdentifier.getRawId();

// create an identifier from a given raw Id
CommunicationIdentifier identifier = CommunicationIdentifier.fromRawId(rawId);

Un identificador sin procesar no válido simplemente se convertirá en un UnknownIdentifier en el SDK y cualquier validación solo se produce en el lado del servicio.

Usuario de comunicación

CommunicationUserIdentifier representa una identidad de usuario que se creó mediante el SDK de identidad o la API de REST. Es el único identificador que se usa si la aplicación no usa las características de interoperabilidad o telefonía de Microsoft Teams.

Uso básico

// at some point you will have created a new user identity in your trusted service
// and send the new user id down to your client application
// where you can create an identifier for the user
let user = CommunicationUserIdentifier(newUserId)

Referencia de la API

Usuario de Microsoft Teams

La MicrosoftTeamsUserIdentifier representa un usuario de Teams con su identificador de objeto de usuario de Microsoft Entra. Puedes recuperar el identificador de objeto de usuario de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph. Como alternativa, puedes encontrar el identificador como la notificación oid en un token de identificador o en un token de acceso de Microsoft Entra después de que el usuario haya iniciado sesión y adquirido un token.

Uso básico

// get the Teams user's ID if only the email is known, assuming a helper method for the Graph API
let userId = await getUserIdFromGraph("bob@contoso.com")

// create an identifier
let teamsUser = MicrosoftTeamsUserIdentifier(userId: userId)

// if you're not operating in the public cloud, you must also pass the right Cloud type.
let gcchTeamsUser = MicrosoftTeamsUserIdentifier(userId: userId, cloud: CommunicationCloudEnvironment.Gcch)

Referencia de la API

Número de teléfono

PhoneNumberIdentifier representa un número de teléfono. El servicio supone que los números de teléfono tienen formato E.164.

Uso básico

// create an identifier
let phoneNumber = PhoneNumberIdentifier(phoneNumber: "+112345556789")

Referencia de la API

Aplicación de Microsoft Teams

La interfaz MicrosoftTeamsAppIdentifier representa un bot de las aplicaciones de voz de Teams, como Cola de llamadas y Operador automático con su identificador de objeto de bot de Microsoft Entra. Las aplicaciones de Teams deben configurarse con una cuenta de recurso. Puedes recuperar el identificador de objeto de bot de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph.

Uso básico

// Get the Microsoft Teams App's ID from Graph APIs, assuming a helper method for the Graph API
let botId = await getBotIdFromGraph()

// Create an identifier
let teamsAppIdentifier = MicrosoftTeamsAppIdentifier(appId: botId)

// If you're not operating in the public cloud, you must also pass the right Cloud type.
let gcchTeamsAppIdentifier = MicrosoftTeamsAppIdentifier(appId: botId, cloudEnvironment: CommunicationCloudEnvironment.Gcch)

Referencia de la API

Unknown

UnknownIdentifier existe para futuras correcciones, y es posible que se lo encuentre cuando esté en una versión anterior del SDK y se haya introducido recientemente un nuevo tipo de identificador. Cualquier identificador desconocido del servicio se deserializará en el UnknownIdentifier del SDK.

Uso básico

// create an identifier
let unknown = UnknownIdentifier("a raw id that originated in the service")

Referencia de la API

Cómo controlar el protocolo base `CommunicationIdentifier`

Mientras construye identificadores para un tipo concreto que se pasa al SDK, el SDK devuelve el protocolo CommunicationIdentifier. Es fácil revertir a un tipo concreto y se recomienda una instrucción de cambio de mayúsculas y minúsculas con coincidencia de patrones:

switch (communicationIdentifier)
{
    case let communicationUser as CommunicationUserIdentifier:
        print(#"Communication user: \(communicationUser.id)"#)
    case let teamsUser as MicrosoftTeamsUserIdentifier:
        print(#"Teams user: \(teamsUser.UserId)"#)
    case let phoneNumber as PhoneNumberIdentifier:
        print(#"Phone number: \(phoneNumber.PhoneNumber)"#)
    case let bot as MicrosoftBotIdentifier:
        print(#"Microsoft bot: \(bot.botId)"#)
    case let unknown as UnknownIdentifier:
        print(#"Unknown: \(unknown.Id)"#)
    @unknown default:
        // be careful here whether you want to throw because a new SDK version
        // can introduce new identifier types
        break;
}

Representación de ID sin formato

A veces es necesario serializar un identificador en una cadena plana. Por ejemplo, si desea almacenar el identificador en una tabla de base de datos o si desea usarlo como parámetro de dirección URL.

Para ello, los identificadores tienen otra representación denominada RawId. Un identificador siempre se puede traducir a su identificador sin procesar correspondiente y siempre se puede convertir un identificador sin procesar válido en un identificador.

Desde Azure.Communication.Common 1.1.0 el SDK ayuda con la conversión:

Swift

// get an identifier's raw Id
let rawId = communicationIdentifier.rawId;

// create an identifier from a given raw Id
let identifier = createCommunicationIdentifier(fromRawId: rawId);

Un identificador sin procesar no válido simplemente se convertirá en un UnknownIdentifier en el SDK y cualquier validación solo se produce en el lado del servicio.

Usuario de comunicación

CommunicationUserIdentifier representa una identidad de usuario que se creó mediante el SDK de identidad o la API de REST. Es el único identificador que se usa si la aplicación no usa las características de interoperabilidad o telefonía de Microsoft Teams.

Uso básico

// at some point you will have created a new user identity in your trusted service
CommunicationUserIdentifier newUser = identityClient.CreateUser();

// and then send newUser.getId() down to your client application
// where you can again create an identifier for the user
CommunicationUserIdentifier sameUser = new CommunicationUserIdentifier(newUserId);

Referencia de la API

Usuario de Microsoft Teams

La MicrosoftTeamsUserIdentifier representa un usuario de Teams con su identificador de objeto de usuario de Microsoft Entra. Puedes recuperar el identificador de objeto de usuario de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph. Como alternativa, puedes encontrar el identificador como la notificación oid en un token de identificador o en un token de acceso de Microsoft Entra después de que el usuario haya iniciado sesión y adquirido un token.

Uso básico

// get the Teams user's ID from Graph APIs if only the email is known
User user = graphClient.users("bob@contoso.com")
    .buildRequest()
    .get();

// create an identifier
MicrosoftTeamsUserIdentifier teamsUser = new MicrosoftTeamsUserIdentifier(user.id);

// if you're not operating in the public cloud, you must also set the right Cloud type.
MicrosoftTeamsUserIdentifier gcchTeamsUser = new MicrosoftTeamsUserIdentifier(userId).setCloudEnvironment(CommunicationCloudEnvironment.GCCH);

Referencia de la API

Número de teléfono

PhoneNumberIdentifier representa un número de teléfono. El servicio supone que los números de teléfono tienen formato E.164.

Uso básico

// create an identifier
PhoneNumberIdentifier phoneNumber = new PhoneNumberIdentifier("+112345556789");

Referencia de la API

Aplicación de Microsoft Teams

La interfaz MicrosoftTeamsAppIdentifier representa un bot de las aplicaciones de voz de Teams, como Cola de llamadas y Operador automático con su identificador de objeto de bot de Microsoft Entra. Las aplicaciones de Teams deben configurarse con una cuenta de recurso. Puedes recuperar el identificador de objeto de bot de Microsoft Entra mediante el punto de conexión /users de la API de REST de Microsoft Graph de la id propiedad en la respuesta. Para obtener más información sobre cómo trabajar con Microsoft Graph, pruebe el Explorador de Graph y examine el SDK de Graph.

Uso básico

// Get the Microsoft Teams App's ID from Graph APIs
UserCollectionPage users = graphClient.users()
	.buildRequest()
	.filter(filterConditions)
	.select("displayName,id")
	.get();

//Here we assume that you have a function getBotFromUsers that gets the bot from the returned response
User bot = getBotFromUsers(users);

// Create an identifier
MicrosoftTeamsAppIdentifier teamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id);

// If you're not operating in the public cloud, you must also pass the right Cloud type.
MicrosoftTeamsAppIdentifier gcchTeamsAppIdentifier = new MicrosoftTeamsAppIdentifier(bot.id, CommunicationCloudEnvironment.GCCH);

Referencia de la API

Unknown

UnknownIdentifier existe para futuras correcciones, y es posible que se lo encuentre cuando esté en una versión anterior del SDK y se haya introducido recientemente un nuevo tipo de identificador. Cualquier identificador desconocido del servicio se deserializará en el UnknownIdentifier del SDK.

Uso básico

// create an identifier
UnknownIdentifier unknown = new UnknownIdentifier("a raw id that originated in the service");

Referencia de la API