Class CalendarEvent

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
CalendarEvent

Representa um único evento da agenda.

Métodos

MétodoTipo de retornoBreve descrição
addEmailReminder(minutesBefore)CalendarEventAdiciona um novo lembrete por e-mail ao evento.
addGuest(email)CalendarEventAdiciona um convidado ao evento.
addPopupReminder(minutesBefore)CalendarEventAdiciona um novo lembrete pop-up ao evento.
addSmsReminder(minutesBefore)CalendarEventAdiciona um novo lembrete por SMS ao evento.
anyoneCanAddSelf()BooleanDefine se alguém pode convidar a si mesmo.
deleteEvent()voidExclui o evento.
deleteTag(key)CalendarEventExclui uma tag de chave-valor do evento.
getAllDayEndDate()DateRecebe a data de término do evento da agenda durante todo o dia.
getAllDayStartDate()DateRecebe a data de início deste evento na agenda de um dia inteiro.
getAllTagKeys()String[]Acessa todas as chaves de tags que foram definidas no evento.
getColor()StringRetorna a cor do evento da agenda.
getCreators()String[]Recebe os criadores do evento.
getDateCreated()DateAcessa a data de criação do evento.
getDescription()StringRecebe a descrição do evento.
getEmailReminders()Integer[]Recebe os valores de minutos de todos os lembretes por e-mail do evento.
getEndTime()DateRecebe a data e a hora em que o evento da agenda termina.
getEventSeries()CalendarEventSeriesRecebe a série de eventos recorrentes aos quais este evento pertence.
getGuestByEmail(email)EventGuestRecebe um convidado por endereço de e-mail.
getGuestList()EventGuest[]Recebe os convidados do evento, sem incluir o proprietário.
getGuestList(includeOwner)EventGuest[]Recebe os convidados do evento, possivelmente incluindo os proprietários.
getId()StringRecebe o iCalUID exclusivo do evento.
getLastUpdated()DateRecebe a data da última atualização do evento.
getLocation()StringAcessa o local do evento.
getMyStatus()GuestStatusRecebe o status de evento (participante etc.) do usuário efetivo.
getOriginalCalendarId()StringObter o ID da agenda em que o evento foi criado originalmente.
getPopupReminders()Integer[]Recebe os valores de minutos de todos os lembretes pop-up do evento.
getSmsReminders()Integer[]Recebe os valores de minutos de todos os lembretes por SMS do evento.
getStartTime()DateRecebe a data e a hora em que o evento da agenda começa.
getTag(key)StringAcessa um valor de tag do evento.
getTitle()StringRecebe o título do evento.
getVisibility()VisibilityRecebe a visibilidade do evento.
guestsCanInviteOthers()BooleanDetermina se é possível convidar outras pessoas.
guestsCanModify()BooleanDetermina se os convidados podem modificar o evento.
guestsCanSeeGuests()BooleanDetermina se os convidados podem ver outras pessoas.
isAllDayEvent()BooleanDetermina se esse é um evento de dia inteiro.
isOwnedByMe()BooleanDetermina se o evento pertence ao usuário efetivo.
isRecurringEvent()BooleanDetermina se o evento faz parte de uma série de eventos.
removeAllReminders()CalendarEventRemove todos os lembretes do evento.
removeGuest(email)CalendarEventRemove um convidado do evento.
resetRemindersToDefault()CalendarEventRedefine os lembretes usando as configurações padrão da agenda.
setAllDayDate(date)CalendarEventDefine a data do evento.
setAllDayDates(startDate, endDate)CalendarEventDefine as datas do evento.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventDefine se pessoas que não foram convidadas podem se adicionar ao evento.
setColor(color)CalendarEventDefine a cor do evento da agenda.
setDescription(description)CalendarEventDefine a descrição do evento.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventDefine se os convidados podem convidar outras pessoas.
setGuestsCanModify(guestsCanModify)CalendarEventDefine se os convidados podem modificar o evento.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventDefine se os convidados podem ver outras pessoas.
setLocation(location)CalendarEventDefine o local do evento.
setMyStatus(status)CalendarEventDefine o status do evento (participação etc.) do usuário efetivo.
setTag(key, value)CalendarEventDefine uma tag de chave-valor no evento para armazenar metadados personalizados.
setTime(startTime, endTime)CalendarEventDefine as datas e os horários de início e término do evento.
setTitle(title)CalendarEventDefine o título do evento.
setVisibility(visibility)CalendarEventDefine a visibilidade do evento.

Documentação detalhada

addEmailReminder(minutesBefore)

Adiciona um novo lembrete por e-mail ao evento. O lembrete precisa ser de pelo menos cinco minutos e, no máximo, quatro semanas (40320 minutos) antes do evento.

Parâmetros

NomeTipoDescrição
minutesBeforeIntegerO número de minutos antes do evento

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Gera

Error: se houver mais de cinco lembretes no evento ou o horário não estiver dentro do intervalo legal

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addGuest(email)

Adiciona um convidado ao evento.

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.addGuest(attendeeEmail);
  }

// Example 2: Add a guest to all events on a calendar within a specified timeframe
function addAttendeeToAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.addGuest(attendeeEmail);
  }
}

Parâmetros

NomeTipoDescrição
emailStringO endereço de e-mail do convidado.

Retornar

CalendarEvent: este CalendarEvent para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addPopupReminder(minutesBefore)

Adiciona um novo lembrete pop-up ao evento. O lembrete precisa ser de pelo menos cinco minutos e, no máximo, quatro semanas (40320 minutos) antes do evento.

Parâmetros

NomeTipoDescrição
minutesBeforeIntegerO número de minutos antes do evento

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addSmsReminder(minutesBefore)

Adiciona um novo lembrete por SMS ao evento. O lembrete precisa ser de pelo menos cinco minutos e, no máximo, quatro semanas (40320 minutos) antes do evento.

Parâmetros

NomeTipoDescrição
minutesBeforeIntegerO número de minutos antes do evento

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Gera

Error: se houver mais de cinco lembretes no evento ou o horário não estiver dentro do intervalo legal

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

anyoneCanAddSelf()

Define se alguém pode convidar a si mesmo.

Retornar

Boolean: true se pessoas que não forem convidados podem se adicionar ao evento. Caso contrário, false

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

deleteEvent()

Exclui o evento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

deleteTag(key)

Exclui uma tag de chave-valor do evento.

Parâmetros

NomeTipoDescrição
keyStringa chave de tag

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getAllDayEndDate()

Recebe a data de término do evento da agenda durante todo o dia. Se este não for um evento de dia inteiro, esse método gerará uma exceção. O Date retornado representa a meia-noite no início do dia após o término do evento no fuso horário do script. Para usar o fuso horário da agenda, chame getEndTime().

Retornar

Date: a data de término deste evento de dia inteiro

Gera

Error: se este evento não for de um dia inteiro

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getAllDayStartDate()

Recebe a data de início deste evento na agenda de um dia inteiro. Se este não for um evento de dia inteiro, esse método gerará uma exceção. A Date retornada representa a meia-noite no início do dia em que o evento começa no fuso horário do script. Para usar o fuso horário da agenda, chame getStartTime().

Retornar

Date: a data de início deste evento de dia inteiro

Gera

Error: se este evento não for de um dia inteiro

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getAllTagKeys()

Acessa todas as chaves de tags que foram definidas no evento.

Retornar

String[]: uma matriz de chaves de string.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getColor()

Retorna a cor do evento da agenda.

Retornar

String: a representação da string da cor do evento, como um índice (1-11) de valores de CalendarApp.EventColor.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCreators()

Recebe os criadores do evento.

Retornar

String[]: os endereços de e-mail dos criadores do evento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDateCreated()

Acessa a data de criação do evento.

Retornar

Date: a data de criação

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDescription()

Recebe a descrição do evento.

Retornar

String: é a descrição

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEmailReminders()

Recebe os valores de minutos de todos os lembretes por e-mail do evento.

Retornar

Integer[]: uma matriz em que cada valor corresponde ao número de minutos antes do evento acionado por um lembrete.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEndTime()

Recebe a data e a hora em que o evento da agenda termina. Para eventos de dia inteiro, esse é o horário em que o evento foi definido para terminar. Para eventos de dia inteiro, que só armazenam uma data de término (não uma data e hora), é à meia-noite do início do dia após o término do evento no fuso horário da agenda. Isso permite uma comparação significativa dos tempos de término para todos os tipos de eventos, mas não preserva necessariamente o dia do ano original inalterado.

Para eventos de dia inteiro, getAllDayEndDate() quase sempre precisa ser chamado em vez deste método.

Retornar

Date: horário de término deste evento na agenda

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventSeries()

Recebe a série de eventos recorrentes aos quais este evento pertence. Um objeto CalendarEventSeries é retornado mesmo que esse evento não pertença a uma série, para que você possa adicionar novas configurações de recorrência.

Retornar

CalendarEventSeries: a série de eventos a que este evento pertence ou uma nova série de eventos se ainda não pertencer a uma série

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestByEmail(email)

Recebe um convidado por endereço de e-mail.

Parâmetros

NomeTipoDescrição
emailStringo endereço do hóspede

Retornar

EventGuest: o convidado ou nulo se o endereço de e-mail não corresponder a um convidado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getGuestList()

Recebe os convidados do evento, sem incluir o proprietário.

Retornar

EventGuest[]: uma matriz de convidados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestList(includeOwner)

Recebe os convidados do evento, possivelmente incluindo os proprietários.

Parâmetros

NomeTipoDescrição
includeOwnerBooleanincluir os proprietários como convidados

Retornar

EventGuest[]: uma matriz de convidados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getId()

Recebe o iCalUID exclusivo do evento. O iCalUID e o evento id usados pela API Calendar v3 e pelo serviço avançado do Agenda não são idênticos e não podem ser usados de maneira intercambiável. Uma diferença na semântica é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, enquanto todos compartilham os mesmos iCalUIDs.

Retornar

String: o iCalUID do evento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getLastUpdated()

Recebe a data da última atualização do evento.

Retornar

Date: a data da última atualização

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getLocation()

Acessa o local do evento.

Retornar

String: o local do evento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getMyStatus()

Recebe o status de evento (participante etc.) do usuário efetivo. Sempre retornará GuestStatus.OWNER se o usuário em vigor for o proprietário do evento.

Retornar

GuestStatus: o status

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOriginalCalendarId()

Obter o ID da agenda em que o evento foi criado originalmente.

Retornar

String: o ID da agenda original

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getPopupReminders()

Recebe os valores de minutos de todos os lembretes pop-up do evento.

Retornar

Integer[]: uma matriz em que cada valor corresponde ao número de minutos antes do evento acionado por um lembrete.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getSmsReminders()

Recebe os valores de minutos de todos os lembretes por SMS do evento.

Retornar

Integer[]: uma matriz em que cada valor corresponde ao número de minutos antes do evento acionado por um lembrete.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getStartTime()

Recebe a data e a hora em que o evento da agenda começa. Para eventos de dia inteiro, esse é o momento em que o evento foi definido para começar. Para eventos de dia inteiro, que só armazenam uma data de início (não uma data e hora), é à meia-noite do início do dia em que o evento começa no fuso horário da agenda. Isso permite uma comparação significativa dos horários de início de todos os tipos de eventos. No entanto, isso não preserva necessariamente o dia de ano original sem modificações.

Para eventos de dia inteiro, getAllDayStartDate() precisa ser quase sempre chamado de preferência para esse método.

Retornar

Date: horário de início deste evento da agenda

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTag(key)

Acessa um valor de tag do evento.

Parâmetros

NomeTipoDescrição
keyStringa chave

Retornar

String: o valor da tag

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTitle()

Recebe o título do evento.

Retornar

String: o título

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getVisibility()

Recebe a visibilidade do evento.

Retornar

Visibility: o valor da visibilidade.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanInviteOthers()

Determina se é possível convidar outras pessoas.

Retornar

Boolean: true se os convidados puderem convidar outras pessoas; false se não forem

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanModify()

Determina se os convidados podem modificar o evento.

Retornar

Boolean: true se os convidados puderem modificar o evento. false se não forem

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanSeeGuests()

Determina se os convidados podem ver outras pessoas.

Retornar

Boolean: true se os convidados podem ver outros convidados; false se não forem

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isAllDayEvent()

Determina se esse é um evento de dia inteiro.

Retornar

Boolean: true se o evento for de dia inteiro; false se não for

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isOwnedByMe()

Determina se o evento pertence ao usuário efetivo.

Retornar

Boolean: true se o evento pertencer ao usuário efetivo; false se não for

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isRecurringEvent()

Determina se o evento faz parte de uma série de eventos.

Retornar

Boolean: true se o evento fizer parte de uma série de eventos; false se não for

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

removeAllReminders()

Remove todos os lembretes do evento.

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

removeGuest(email)

Remove um convidado do evento.

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.removeGuest(attendeeEmail);
  }

// Example 2: Remove a guest from all events on a calendar within a specified timeframe
function removeGuestFromAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.removeGuest(attendeeEmail);
  }
}

Parâmetros

NomeTipoDescrição
emailStringO endereço de e-mail do convidado

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

resetRemindersToDefault()

Redefine os lembretes usando as configurações padrão da agenda.

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAllDayDate(date)

Define a data do evento. Aplicar este método transforma um evento normal em um evento de dia inteiro.

Parâmetros

NomeTipoDescrição
dateDatea data do evento (a hora é ignorada);

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAllDayDates(startDate, endDate)

Define as datas do evento. A aplicação desse método altera um evento regular em um evento de dia inteiro.

Parâmetros

NomeTipoDescrição
startDateDatea data de início do evento (o horário é ignorado)
endDateDatea data de término do evento (o horário é ignorado)

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAnyoneCanAddSelf(anyoneCanAddSelf)

Define se pessoas que não foram convidadas podem se adicionar ao evento.

Parâmetros

NomeTipoDescrição
anyoneCanAddSelfBooleanse alguém pode convidar a si mesmo

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setColor(color)

Define a cor do evento da agenda.

Parâmetros

NomeTipoDescrição
colorStringUm índice de cores com números inteiros, como uma string ou um valor de CalendarApp.EventColor.

Retornar

CalendarEvent: este evento da agenda para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

Define a descrição do evento.

Parâmetros

NomeTipoDescrição
descriptionStringa nova descrição

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanInviteOthers(guestsCanInviteOthers)

Define se os convidados podem convidar outras pessoas.

Parâmetros

NomeTipoDescrição
guestsCanInviteOthersBooleanse os convidados podem convidar outras pessoas

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanModify(guestsCanModify)

Define se os convidados podem modificar o evento.

Parâmetros

NomeTipoDescrição
guestsCanModifyBooleanse os convidados podem modificar o evento;

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanSeeGuests(guestsCanSeeGuests)

Define se os convidados podem ver outras pessoas.

Parâmetros

NomeTipoDescrição
guestsCanSeeGuestsBooleanse os convidados podem ver outras pessoas

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setLocation(location)

Define o local do evento.

Parâmetros

NomeTipoDescrição
locationStringo novo local

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setMyStatus(status)

Define o status do evento (participação etc.) do usuário efetivo.

Parâmetros

NomeTipoDescrição
statusGuestStatuso novo status

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

setTag(key, value)

Define uma tag de chave-valor no evento para armazenar metadados personalizados.

Parâmetros

NomeTipoDescrição
keyStringa chave de tag
valueStringo valor da tag

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTime(startTime, endTime)

Define as datas e os horários de início e término do evento. A aplicação desse método altera um evento de dia inteiro em um evento regular.

Parâmetros

NomeTipoDescrição
startTimeDateo novo início do evento
endTimeDateo novo fim do evento.

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTitle(title)

Define o título do evento.

Parâmetros

NomeTipoDescrição
titleStringo novo título

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setVisibility(visibility)

Define a visibilidade do evento.

Parâmetros

NomeTipoDescrição
visibilityVisibility

Retornar

CalendarEvent: este CalendarEvent para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds