tipo de recurso calendar
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Representa um contêiner para recursos de evento. Pode ser um calendário para um usuárioou o calendário padrão de um grupo do Microsoft 365.
Observação: existem algumas pequenas diferenças na maneira como você pode interagir com calendários de usuários e calendários de grupos:
- Você pode organizar apenas os calendários de usuários em calendarGroup.
- O Outlook aceita automaticamente todas as solicitações de reunião em nome de grupos. Pode aceitar, aceitar em modo de tentativa ou recusar pedidos de reunião apenas para calendários de utilizador.
- O Outlook não oferece suporte a lembretes de eventos do grupo. Você pode adiar ou descartar um lembrete apenas para calendários do usuário.
Métodos
Método | Tipo de retorno | Descrição |
---|---|---|
List | Coleção calendar | Obtenha todos os calendários do usuário ou os calendários no grupo de calendários padrão ou em outro grupo de calendários específico. |
Create | calendar | Crie um novo calendário no grupo de calendário padrão ou no grupo de calendários especificado para um usuário. |
Get | calendar | Obtenha as propriedades e as relações de um objeto calendar. O calendário pode ser um para um usuário ou o calendário padrão de um grupo do Microsoft 365. |
Update | calendar | Atualize as propriedades de um objeto calendar. O calendário pode ser um para um usuário ou o calendário padrão de um grupo do Microsoft 365. |
Delete | Nenhum | Exclua um objeto calendar. |
Excluir permanentemente | Nenhum | Elimine permanentemente a pasta do calendário e remova-a da caixa de correio. |
Listar modo de exibição de calendário | Coleção event | Obtenha as ocorrências, as exceções e as instâncias de eventos únicas em uma visão de calendário definida por um intervalo de tempo, do calendário principal do usuário (../me/calendarView) ou de um calendário especificado. |
Listar eventos | Coleção event | Recupere uma lista de eventos em um calendário. A lista contém reuniões de instância única e reuniões mestres em série. |
Criar evento | event | Crie um novo evento no calendário especificado ou padrão. |
Obter agenda de disponibilidade | Coleção scheduleInformation | Obtenha as informações de disponibilidade para um conjunto de usuários, listas de distribuição ou recursos para um período especificado. |
Encontrar horários de reunião | meetingTimeSuggestionsResult | Sugira horários e locais para a reunião com base no organizador e na disponibilidade dos participantes, além de restrições de horário ou local. |
Criar uma propriedade de valor único | calendar | Criar uma ou mais propriedades estendidas de valor único em um calendário novo ou existente. |
Obter uma propriedade de valor único | calendar | Obter calendários que contenham uma propriedade estendida de valor único usando $expand ou $filter . |
Criar propriedade com múltiplos valores | calendar | Criar uma ou mais propriedades estendidas de vários valores em um calendário novo ou existente. |
Obter propriedade de múltiplos valores | calendar | Obter um calendário que contenha uma propriedade estendida de vários valores usando $expand . |
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
allowedOnlineMeetingProviders | onlineMeetingProviderType collection | Represente os provedores de serviços de reunião online que podem ser usados para criar reuniões online neste calendário. Os valores possíveis são: unknown , skypeForBusiness , skypeForConsumer , teamsForBusiness . |
calendarGroupId | Cadeia de caracteres | O calendarGroup para criar o calendário. Se o utilizador nunca tiver definido explicitamente um grupo para o calendário, esta propriedade é nula. |
canEdit | Booliano |
true se o usuário pode escrever no calendário, false caso contrário. Esta propriedade é true para o usuário que criou o calendário. Esta propriedade true também se aplica a um usuário que compartilhou um calendário e recebeu acesso de gravação por meio de um cliente Outlook ou do recurso calendarPermission correspondente. Somente leitura. |
canShare | Boolean |
true se o usuário tiver permissão para compartilhar a agenda, false caso contrário. Apenas o usuário que criou o calendário pode compartilhá-lo. Apenas leitura. |
canViewPrivateItems | Boolean |
true se o usuário pode ler itens de calendário que foram marcados como privados, false caso contrário. Essa propriedade é definida por meio de um cliente do Outlook ou o do recurso calendarPermission correspondente. Apenas leitura. |
changeKey | String | Identifica a versão do objeto calendar. Sempre que o calendário é alterado, changeKey também é alterado. Isso permite que o Exchange aplique as alterações na versão correta do objeto. Somente leitura. |
color | calendarColor | Especifica o tema de cores para distinguir o calendário de outros calendários em uma interface do usuário. Os valores das propriedades são: auto , lightBlue , lightGreen , lightOrange , lightGray , lightYellow , lightTeal , lightPink , lightBrown , lightRed , maxColor |
defaultOnlineMeetingProvider | onlineMeetingProviderType | O provedor de reunião online padrão para reuniões enviadas deste calendário. Os valores possíveis são: unknown , skypeForBusiness , skypeForConsumer , teamsForBusiness . |
hexColor | String | A cor do calendário, expressa em um código de cor hexadecimal de três valores hexadecimais, cada um variando de 00 a FF e representando os componentes vermelho, verde ou azul da cor no espaço de cores RGB. Se o usuário nunca tiver definido explicitamente uma cor para o calendário, esta propriedade estará vazia. |
id | String | Identificador exclusivo do calendário. Somente leitura. |
isDefaultCalendar | Booliano |
true se este for o calendário padrão onde novos eventos são criados por padrão, false caso contrário. |
isRemovable | Booliano | Indica se o calendário deste usuário pode ser excluído da caixa de correio do usuário. |
isShared | Booliano |
true se o usuário compartilhou a agenda com outros usuários, false caso contrário. Como apenas o usuário que criou o calendário pode compartilhá-lo, isShared e isSharedWithMe não podem ser true do mesmo usuário. Essa propriedade é definida quando o compartilhamento é iniciado em um cliente do Outlook e pode ser redefinido quando o compartilhamento é cancelado pelo cliente ou pelo recurso calendarPermission correspondente. Somente leitura. |
isSharedWithMe | Booliano |
true se o usuário foi compartilhado neste calendário, false caso contrário. Esta propriedade é sempre false para o proprietário de um calendário. Essa propriedade é definida quando o compartilhamento é iniciado em um cliente do Outlook e pode ser redefinido quando o compartilhamento é cancelado pelo cliente ou pelo recurso calendarPermission correspondente. Apenas leitura. |
isTallyingResponses | Booliano | Indica se o calendário deste usuário dá suporte ao acompanhamento de respostas de reunião. Somente os convites para reuniões enviados do calendário principal do usuário oferecem suporte para respostas de reunião. |
nome | String | O nome do calendário. |
owner | emailAddress | Se definida, representa o usuário que criou ou adicionou o calendário. Para um calendário que o usuário criou ou adicionou, a propriedade owner é definida para o usuário. Para um calendário compartilhado com o usuário, a propriedade owner é definida para a pessoa que compartilhou o calendário com o usuário. Somente leitura. |
Relações
Relação | Tipo | Descrição |
---|---|---|
calendarPermissions | Coleção de calendarPermission | As permissões dos usuários com os quais o calendário é compartilhado. |
calendarView | Coleção event | O modo de exibição do calendário. Propriedade de navegação. Somente leitura. |
events | Coleção event | Os eventos do calendário. Propriedade de navegação. Somente leitura. |
multiValueExtendedProperties | Coleção multiValueLegacyExtendedProperty | A coleção de propriedades estendidas de vários valores definidas para o calendário. Somente leitura. Anulável. |
singleValueExtendedProperties | Coleção singleValueLegacyExtendedProperty | A coleção de propriedades estendidas de vários valores definidas para a mensagem. Somente leitura. Anulável. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"allowedOnlineMeetingProviders": ["string"],
"canEdit": "boolean",
"canShare": "boolean",
"canViewPrivateItems": "boolean",
"changeKey": "string",
"color": "String",
"defaultOnlineMeetingProvider": "string",
"hexColor": "String",
"id": "string (identifier)",
"isDefaultCalendar": "boolean",
"isRemovable": "boolean",
"isShared": "boolean",
"isSharedWithMe": "boolean",
"isTallyingResponses": "boolean",
"name": "string",
"owner": {"@odata.type": "microsoft.graph.emailAddress"}
}