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. |
Obtención del canal principal | channel | El canal general del equipo |
Canal de actualización | channel | Actualiza las propiedades del canal. |
Eliminar canal | Ninguno | Elimina un canal. |
Obtener mensaje delta | chatMessage | Obtenga mensajes incrementales en 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. |
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 | Obtiene la lista de miembros de un canal. |
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. |
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 . |
Completar migración | channel | Quita el modo de migración del canal y pone el canal a disposición de los usuarios para publicar y leer mensajes. |
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. |
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 han compartido el canal especificado. |
Obtener el equipo que comparte un canal | sharedWithChannelTeamInfo | Obtenga un equipo que haya compartido 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. |
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
description | Cadena | Descripción textual opcional para el canal. |
displayName | Cadena | Nombre del canal que se mostrará al usuario en Microsoft Teams. La longitud máxima es de 50 caracteres. |
id | Cadena | Identificador único de los canales. Solo lectura. |
isFavoriteByDefault | Boolean | Indica si el canal debe marcarse automáticamente como "favorito" para todos los miembros del equipo. Solo se puede configurar mediante programación con Crear equipo. Valor predeterminado: false . |
Cadena | La dirección de correo electrónico para enviar mensajes al canal. Solo lectura. | |
webUrl | Cadena | Un hipervínculo que irá hasta el canal en Microsoft Teams. Esta es la dirección URL que obtendrá cuando haga clic en un canal en Microsoft Teams y seleccione 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 . Tenga en cuenta que debe usar el encabezado de solicitud Prefer: include-unknown-enum-members para obtener el siguiente valor en esta enumeración activable: shared . |
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. |
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 inquilinos. La propiedad summary solo se devolverá si se especifica en la $select cláusula del método de canal Get . |
tenantId | string | Identificador del inquilino de Microsoft Entra. |
valores channelMembershipType
Member | Descripción |
---|---|
estándar | Channel hereda la lista de miembros del equipo primario. |
Privado | El canal puede tener miembros que son un subconjunto de todos los miembros del equipo primario. |
unknownFutureValue | Valor de sentinel de enumeración evolvable. No usar. |
compartido | Los miembros se pueden agregar directamente al canal sin agregarlos al equipo. |
Atributos de instancia
Los atributos de instancia son propiedades con comportamientos especiales. Estas propiedades son temporales y o bien a) definen el comportamiento que debería tener el servicio o b) proporcionan valores de propiedad a corto plazo, como una dirección URL de descarga de 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 valormigration
.
Para ver un ejemplo de solicitud POST, consulte Solicitar (crear un canal en estado de migración).
Relaciones
Relación | Tipo | Descripción |
---|---|---|
messages | Colección chatMessage | Una colección de todos los mensajes en el canal. Una propiedad de navegación. Admite un valor NULL. |
pestañas | Colección teamsTab | Una colección de todas las pestañas en el canal. Una propiedad de navegación. |
miembros | Colección conversationmember | Una colección de registros de suscripción asociados al canal. |
filesFolder | driveItem | Metadatos para la ubicación en la que se almacenan los archivos del canal. |
operations | Colección teamsAsyncOperation | Las operaciones asincrónicas que se han ejecutado o se ejecutan en este equipo. |
sharedWithTeams | Colección sharedWithChannelTeamInfo | Una colección de equipos con los que se comparte un canal. |
Representación JSON
Esta es una representación JSON del recurso.
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"isFavoriteByDefault": true,
"email": "string",
"webUrl": "string",
"membershipType": "String",
"createdDateTime": "string (timestamp)",
"moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}