Tipo de recurso channel

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Los equipos están compuestos de canales, que son las conversaciones que tiene con sus compañeros de equipo. Cada canal está dedicado a un tema específico, departamento o proyecto. Los canales son el lugar donde realmente se realiza el trabajo, donde se producen conversaciones de texto, audio y vídeo abiertas a todo el equipo, donde se comparten archivos y se agregan las pestañas.

Métodos

Método Tipo de valor devuelto Descripción
Enumerar canales Colección channel Obtiene la lista de canales en un equipo.
Enumerar canales entrantes Colección channel Obtiene la lista de canales compartidos con un equipo.
Enumerar todos los canales Colección channel Obtiene la lista de canales en un equipo o compartidos con un equipo (canales entrantes).
Crear un canal channel Crea un canal, incluyendo el nombre para mostrar y la descripción.
Obtener canal channel Lee las propiedades y relaciones del canal.
Obtener canal principal channel El canal general del equipo
Canal de actualización channel Actualiza las propiedades del canal.
Eliminar canal Ninguno Elimina un canal.
Enumerar mensajes de canal chatMessage Obtiene los mensajes en un canal
Obtener todos los mensajes del canal Colección channel Obtiene todos los mensajes de todos los canales en los que un usuario es participante.
Obtener todos los mensajes de canal retenidos Colección chatMessage Obtenga todos los mensajes retenidos en todos los canales de un equipo.
Crear publicación de mensaje del canal chatMessage Enviar un mensaje a un canal
Crear respuesta a publicación de mensaje del canal chatMessage Responder a un mensaje en un canal
Obtener la carpeta de los archivos. driveItem Recupera los detalles de la carpeta de SharePoint donde se almacenan los archivos para el canal.
Enumerar pestañas teamsTab Enumera las pestañas ancladas a un canal.
Enumerar miembros de canal Colección conversationmember Obtenga una lista de los miembros de un canal, incluidos los miembros directos de los canales estándar, privados y compartidos.
Enumerar todos los miembros Colección conversationmember Obtenga una lista de todos los miembros de un canal.
Obtener miembro del canal allMembers collection conversationMember Recupere un único conversationMember (directo o indirecto) de la colección allMembers mediante el id. de pertenencia.
Agregar miembro de canal conversationMember Agregue un miembro a una clase o canal. Solo se admite para canales con un elemento membershipType de private o shared.
Obtener miembro de canal Colección conversationmember Obtiene un miembro de un canal.
Canal de Archivo Ninguno Archivo un canal.
Desarchivar canal Ninguno Desarchivar un canal.
Actualizar el rol del miembro del canal conversationMember Actualizar las propiedades de un miembro del canal. Solo se admite para canales con un elemento membershipType de private o shared.
Quitar miembro de canal Ninguno Eliminar un miembro de un canal. Solo se admite para canales con un elemento membershipType de private o shared.
Iniciar la migración channel Inicie la migración de mensajes externos habilitando el modo de migración en un canal existente.
Completar migración channel Completar la migración en canales existentes o canales nuevos.
Enumerar pestañas en el canal teamsTab Enumera las pestañas ancladas de un canal.
Agregar una pestaña al canal teamsTab Agrega (ancla) una pestaña a un canal.
Obtener pestaña de un canal teamsTab Obtiene una pestaña anclada específica de un canal.
Actualizar pestaña en el canal teamsTab Actualiza las propiedades de una pestaña en un canal.
Quitar pestaña del canal Ninguno Quita (desancla) una pestaña de un canal.
Enumerar aplicaciones en el canal Colección teamsApp Obtenga una lista de las aplicaciones habilitadas en el canal especificado dentro de un equipo.
Agregar aplicación al canal Ninguno Agregue un nuevo objeto teamsApp que habilite una aplicación en el canal especificado dentro de un equipo.
Quitar aplicación del canal Ninguno Quite un objeto teamsApp que deshabilita una aplicación en el canal especificado dentro de un equipo.
Disposición de dirección de correo electrónico del canal provisionChannelEmailResult Disponga una dirección de correo electrónico para el canal.
Quitar dirección de correo electrónico del canal Ninguno Quite la dirección de correo electrónico del canal.
Quitar un canal entrante Ninguno Quita un canal entrante (un canal compartido con un equipo) de un equipo.
Enumerar equipos que comparten un canal Colección sharedWithChannelTeamInfo Obtenga la lista de equipos que comparten el canal especificado.
Obtener el equipo que comparte un canal sharedWithChannelTeamInfo Consiga un equipo que comparta el canal especificado.
Dejar de compartir el canal con el equipo Ninguno Deje de compartir un canal con un equipo.
Enumerar miembros permitidos Colección conversationmember Obtenga la lista de miembros del equipo que tienen acceso al canal compartido.
Comprobar acceso del usuario Boolean Compruebe si un usuario tiene acceso a un canal compartido o no.
Planificador
Enumerar planes Colección plannerPlan Obtener una lista de objetos plannerPlan propiedad de un canal compartido en Teams.

Propiedades

Propiedad Tipo Descripción
description Cadena Descripción textual opcional para el canal.
displayName Cadena Nombre del canal tal y como aparece al usuario en Microsoft Teams. La longitud máxima es de 50 caracteres.
id Cadena Identificador único de los canales. Solo lectura.
isFavoriteByDefault Booleano Indica si el canal debe marcarse como recomendado para que todos los miembros del equipo puedan mostrarlo en su lista de canales. Nota: Todos los canales recomendados se muestran automáticamente en la lista de canales para los usuarios de educación y trabajadores de primera línea. La propiedad solo se puede establecer mediante programación mediante el método Create team . El valor predeterminado es false.
modo de migración modo de migración Indica si un canal está en modo de migración. Este valor es null para canales que nunca entraron en modo de migración. Los valores posibles son: inProgress, completed, unknownFutureValue.
email Cadena La dirección de correo electrónico para enviar mensajes al canal. Solo lectura.
webUrl Cadena Un hipervínculo al canal en Microsoft Teams. Esta dirección URL se proporciona al hacer clic con el botón derecho en un canal en Microsoft Teams y seleccionar Obtener vínculo al canal. Esta dirección URL debe tratarse como un objeto opaco y no analizarse. Solo lectura.
membershipType channelMembershipType El tipo de un canal. Se puede establecer durante la creación y no se puede cambiar. Los valores posibles son: standard, private, unknownFutureValue y shared El valor predeterminado es standard. Use el encabezado de solicitud Prefer: include-unknown-enum-members para obtener los siguientes miembros en esta enumeración evolutiva: shared.
layoutType channelLayoutType El tipo de diseño del canal. Se puede establecer durante la creación y actualizarse posteriormente. Los valores posibles son: post, chat, unknownFutureValue. El valor predeterminado es post. Los canales con este post diseño usan un formato tradicional de conversación posterior a la respuesta y los canales con el diseño de chat proporcionan una experiencia de subprocesos similar a la de un chat.
createdDateTime dateTimeOffset Solo lectura. Marca de tiempo en la que se creó el canal.
moderationSettings channelModerationSettings Configuración de la moderación del canal para controlar quién puede iniciar nuevos mensajes y responder a los mensajes de ese canal.
originalCreatedDateTime dateTimeOffset Marca de tiempo de la hora de creación original del canal. El valor es null si el canal nunca entró en el modo de migración.
summary channelSummary Contiene información de resumen sobre el canal, incluido el número de invitados, miembros, propietarios y un indicador para los miembros de otros espacios empresariales. La propiedad de resumen solo se devuelve si aparece en la $select cláusula del método Get channel .
tenantId string El identificador del inquilino de Microsoft Entra.
isArchived Booleano Indica si el canal está archivado. Solo lectura.

valores channelMembershipType

Member Descripción
estándar El canal hereda la lista de miembros del equipo primario.
private El canal puede tener miembros que son un subconjunto de todos los miembros del equipo primario.
unknownFutureValue Valor centinela de enumeración evolutiva. No usar.
compartido Los miembros se pueden agregar directamente al canal sin agregarlos al equipo.

Valores channelLayoutType

Member Descripción
publicar Formato tradicional de conversación posterior a la respuesta. Las publicaciones se muestran en un formato estructurado con respuestas anidadas debajo de la publicación original. Representa el tipo de diseño predeterminado.
chat Experiencia de subprocesos similar a la de un chat similar a los chats de grupo. Los mensajes se muestran en un flujo continuo con soporte para conversaciones encadenadas sobre temas específicos.
unknownFutureValue Valor centinela de enumeración evolutiva. No usar.

valores de migrationMode

Member Descripción
en curso El canal o chat entró en modo de migración.
completada El canal o chat está fuera del modo de migración.
unknownFutureValue Valor centinela de enumeración evolutiva. No usar.

Atributos de instancia

Los atributos de instancia son propiedades con comportamientos especiales. Estas propiedades son temporales. Definen el comportamiento que debe realizar el servicio o proporcionan valores de propiedad a corto plazo, como una dirección URL de descarga para un elemento que expira.

Nombre de propiedad Tipo Description
@microsoft.graph.channelCreationMode cadena Indica que el canal está en estado de migración y se está usando actualmente para propósitos de migración. Acepta un valor: migration.

Nota: channelCreationMode es una enumeración que toma el valor migration.

Para ver un ejemplo de solicitud POST, consulte Solicitar (crear un canal en estado de migración).

Relaciones

Relación Tipo Descripción
allMembers Colección conversationmember Una colección de registros de suscripción asociados al canal. Incluye miembros directos e indirectos de canales compartidos.
enabledApps Colección teamsApp Colección de aplicaciones habilitadas en el canal.
filesFolder driveItem Metadatos para la ubicación en la que se almacenan los archivos del canal.
members Colección conversationmember Una colección de registros de suscripción asociados al canal.
messages Colección chatMessage Una colección de todos los mensajes en el canal. Admite valores NULL.
operations Colección teamsAsyncOperation Las operaciones asincrónicas que se han ejecutado o se ejecutan en este equipo.
planner teamsChannelPlanner Servicios de Planner selectivo disponibles para este canal. Actualmente, solo se admiten canales compartidos. Solo lectura. Admite valores NULL.
sharedWithTeams Colección sharedWithChannelTeamInfo Una colección de equipos con los que se comparte un canal.
pestañas Colección teamsTab Una colección de todas las pestañas en el canal.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "isFavoriteByDefault": true,
  "email": "string",
  "webUrl": "string",
  "membershipType": "String",
  "migrationMode": "String",
  "layoutType": "string",
  "isArchived": false,
  "createdDateTime": "string (timestamp)",
  "originalCreatedDateTime": "String (timestamp)",
  "moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}

Contenido relacionado

  • Last updated on