ExtendedCalendar (Aspose.Email for Java 24.9 API Documentation)

java.lang.Object
- com.aspose.email.BaseDataObject
- - com.aspose.email.Calendar
  - - com.aspose.email.ExtendedCalendar

```
public class ExtendedCalendar
extends Calendar
```
A set of extended metadata, such as a colors, for a single calendar.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXTENDED_CALENDAR_KIND` Type of the resource 'calendar#calendarListEntry'.
`static String`	`LIST_KIND` Type of the resources list 'calendar#calendarList'.

Fields inherited from class com.aspose.email.Calendar
CALENDAR_KIND

Constructor Summary

Constructors
Constructor and Description
`ExtendedCalendar()` Initializes a new instance of the ExtendedCalendar class.
`ExtendedCalendar(String summary)` Initializes a new instance of the ExtendedCalendar class.
`ExtendedCalendar(String id, String summary)` Initializes a new instance of the ExtendedCalendar class.
`ExtendedCalendar(String summary, String description, String location, String timeZone)` Initializes a new instance of the ExtendedCalendar class.
`ExtendedCalendar(String id, String summary, String description, String location, String timeZone)` Initializes a new instance of the ExtendedCalendar class.
`ExtendedCalendar(String id, String summary, String description, String location, String timeZone, String summaryOverride, String colorId, String backgroundColor, String foregroundColor, boolean hidden, boolean selected, int accessRole, KeyValuePair<Integer,Integer>[] defaultReminders, boolean primary)` Initializes a new instance of the ExtendedCalendar class.
`ExtendedCalendar(String id, String eTag, String summary, String description, String location, String timeZone, String summaryOverride, String colorId, String backgroundColor, String foregroundColor, boolean hidden, boolean selected, int accessRole, KeyValuePair<Integer,Integer>[] defaultReminders, boolean primary)` Initializes a new instance of the ExtendedCalendar class.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAccessRole()` The effective access role that the authenticated user has on the calendar.
`String`	`getBackgroundColor()` The main color of the calendar in the format '#0088aa'.
`String`	`getColorId()` The color of the calendar.
`KeyValuePair<Integer,Integer>[]`	`getDefaultReminders()` The default reminders that the authenticated user has for this calendar.
`String`	`getForegroundColor()` The foreground color of the calendar in the format '#ffffff'.
`boolean`	`getHidden()` Whether the calendar has been hidden from the list.
`KeyValuePair<Integer,Integer>[]`	`getNotificationSettings()` The notifications that the authenticated user is receiving for this calendar.
`boolean`	`getPrimary()` Whether the calendar is the primary calendar of the authenticated user.
`boolean`	`getSelected()` Whether the calendar content shows up in the calendar UI.
`String`	`getSummaryOverride()` The summary that the authenticated user has set for this calendar.
`void`	`setBackgroundColor(String value)` The main color of the calendar in the format '#0088aa'.
`void`	`setColorId(String value)` The color of the calendar.
`void`	`setDefaultReminders(KeyValuePair<Integer,Integer>[] value)` The default reminders that the authenticated user has for this calendar.
`void`	`setForegroundColor(String value)` The foreground color of the calendar in the format '#ffffff'.
`void`	`setHidden(boolean value)` Whether the calendar has been hidden from the list.
`void`	`setNotificationSettings(KeyValuePair<Integer,Integer>[] value)` The notifications that the authenticated user is receiving for this calendar.
`void`	`setPrimary(boolean value)` Whether the calendar is the primary calendar of the authenticated user.
`void`	`setSelected(boolean value)` Whether the calendar content shows up in the calendar UI.
`void`	`setSummaryOverride(String value)` The summary that the authenticated user has set for this calendar.
`String`	`toString()` Returns a string which represents the object instance.

Methods inherited from class com.aspose.email.Calendar
getConferenceProperties, getDescription, getLocation, getSummary, getTimeZone, setDescription, setLocation, setSummary, setTimeZone

Methods inherited from class com.aspose.email.BaseDataObject
getETag, getId, getKind, setETag, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EXTENDED_CALENDAR_KIND
```
public static final String EXTENDED_CALENDAR_KIND
```
    Type of the resource 'calendar#calendarListEntry'.
  - LIST_KIND
```
public static final String LIST_KIND
```
    Type of the resources list 'calendar#calendarList'.
- Constructor Detail
  - ExtendedCalendar
```
public ExtendedCalendar()
```
    Initializes a new instance of the ExtendedCalendar class.
  - ExtendedCalendar
```
public ExtendedCalendar(String summary)
```
    Initializes a new instance of the ExtendedCalendar class.
    
    Parameters:
    summary - Title of the calendar.
  - ExtendedCalendar
```
public ExtendedCalendar(String id,
                String summary)
```
    Initializes a new instance of the ExtendedCalendar class.
    
    Parameters:
    id - Identifier of the resource.
    summary - Title of the calendar.
  - ExtendedCalendar
```
public ExtendedCalendar(String summary,
                String description,
                String location,
                String timeZone)
```
    Initializes a new instance of the ExtendedCalendar class.
    
    Parameters:
    summary - Title of the calendar.
    description - Description of the calendar.
    location - Geographic location of the calendar as free-form text.
    timeZone - The time zone of the calendar.
  - ExtendedCalendar
```
public ExtendedCalendar(String id,
                String summary,
                String description,
                String location,
                String timeZone)
```
    Initializes a new instance of the ExtendedCalendar class.
    
    Parameters:
    id - Identifier of the resource.
    summary - Title of the calendar.
    description - Description of the calendar.
    location - Geographic location of the calendar as free-form text.
    timeZone - The time zone of the calendar.
  - ExtendedCalendar
```
public ExtendedCalendar(String id,
                String summary,
                String description,
                String location,
                String timeZone,
                String summaryOverride,
                String colorId,
                String backgroundColor,
                String foregroundColor,
                boolean hidden,
                boolean selected,
                int accessRole,
                KeyValuePair<Integer,Integer>[] defaultReminders,
                boolean primary)
```
    Initializes a new instance of the ExtendedCalendar class.
    
    Parameters:
    id - Identifier of the resource.
    summary - Title of the calendar.
    description - Description of the calendar.
    location - Geographic location of the calendar as free-form text.
    timeZone - The time zone of the calendar.
    summaryOverride - The summary that the authenticated user has set for this calendar.
    colorId - The color of the calendar. This is an ID referring to an entry in the 'calendar' section of the colors definition (see the 'colors' endpoint).
    backgroundColor - The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property.
    foregroundColor - The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property.
    hidden - Whether the calendar has been hidden from the list. The default is False.
    selected - Whether the calendar content shows up in the calendar UI. The default is False.
    accessRole - The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
    defaultReminders - The default reminders that the authenticated user has for this calendar.
    primary - Whether the calendar is the primary calendar of the authenticated user. Read-only. The default is False.
  - ExtendedCalendar
```
public ExtendedCalendar(String id,
                String eTag,
                String summary,
                String description,
                String location,
                String timeZone,
                String summaryOverride,
                String colorId,
                String backgroundColor,
                String foregroundColor,
                boolean hidden,
                boolean selected,
                int accessRole,
                KeyValuePair<Integer,Integer>[] defaultReminders,
                boolean primary)
```
    Initializes a new instance of the ExtendedCalendar class.
    
    Parameters:
    id - Identifier of the resource.
    eTag - An entity tag
    summary - Title of the calendar.
    description - Description of the calendar.
    location - Geographic location of the calendar as free-form text.
    timeZone - The time zone of the calendar.
    summaryOverride - The summary that the authenticated user has set for this calendar.
    colorId - The color of the calendar. This is an ID referring to an entry in the 'calendar' section of the colors definition (see the 'colors' endpoint).
    backgroundColor - The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property.
    foregroundColor - The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property.
    hidden - Whether the calendar has been hidden from the list. The default is False.
    selected - Whether the calendar content shows up in the calendar UI. The default is False.
    accessRole - The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
    defaultReminders - The default reminders that the authenticated user has for this calendar.
    primary - Whether the calendar is the primary calendar of the authenticated user. Read-only. The default is False.
- Method Detail
  - getSummaryOverride
```
public String getSummaryOverride()
```
    The summary that the authenticated user has set for this calendar.
  - setSummaryOverride
```
public void setSummaryOverride(String value)
```
    The summary that the authenticated user has set for this calendar.
  - getColorId
```
public String getColorId()
```
    The color of the calendar. This is an ID referring to an entry in the 'calendar' section of the colors definition (see the 'colors' endpoint).
  - setColorId
```
public void setColorId(String value)
```
    The color of the calendar. This is an ID referring to an entry in the 'calendar' section of the colors definition (see the 'colors' endpoint).
  - getBackgroundColor
```
public String getBackgroundColor()
```
    The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property.
  - setBackgroundColor
```
public void setBackgroundColor(String value)
```
    The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property.
  - getForegroundColor
```
public String getForegroundColor()
```
    The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property.
  - setForegroundColor
```
public void setForegroundColor(String value)
```
    The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property.
  - getHidden
```
public boolean getHidden()
```
    Whether the calendar has been hidden from the list. The default is False.
  - setHidden
```
public void setHidden(boolean value)
```
    Whether the calendar has been hidden from the list. The default is False.
  - getSelected
```
public boolean getSelected()
```
    Whether the calendar content shows up in the calendar UI. The default is False.
  - setSelected
```
public void setSelected(boolean value)
```
    Whether the calendar content shows up in the calendar UI. The default is False.
  - getAccessRole
```
public int getAccessRole()
```
    The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
  - getDefaultReminders
```
public KeyValuePair<Integer,Integer>[] getDefaultReminders()
```
    The default reminders that the authenticated user has for this calendar.
  - setDefaultReminders
```
public void setDefaultReminders(KeyValuePair<Integer,Integer>[] value)
```
    The default reminders that the authenticated user has for this calendar.
  - getNotificationSettings
```
public KeyValuePair<Integer,Integer>[] getNotificationSettings()
```
    The notifications that the authenticated user is receiving for this calendar.
  - setNotificationSettings
```
public void setNotificationSettings(KeyValuePair<Integer,Integer>[] value)
```
    The notifications that the authenticated user is receiving for this calendar.
  - getPrimary
```
public boolean getPrimary()
```
    Whether the calendar is the primary calendar of the authenticated user. Read-only. The default is False.
  - setPrimary
```
public void setPrimary(boolean value)
```
    Whether the calendar is the primary calendar of the authenticated user. Read-only. The default is False.
  - toString
```
public String toString()
```
    Returns a string which represents the object instance.
    
    Overrides:
    
    toString in class Calendar
    
    Returns:
    Returns a string which represents the object instance.

Class ExtendedCalendar

Field Summary

Fields inherited from class com.aspose.email.Calendar

Constructor Summary

Method Summary

Methods inherited from class com.aspose.email.Calendar

Methods inherited from class com.aspose.email.BaseDataObject

Methods inherited from class java.lang.Object

Field Detail

EXTENDED_CALENDAR_KIND

LIST_KIND

Constructor Detail

ExtendedCalendar

ExtendedCalendar

ExtendedCalendar

ExtendedCalendar

ExtendedCalendar

ExtendedCalendar

ExtendedCalendar

Method Detail

getSummaryOverride

setSummaryOverride

getColorId

setColorId

getBackgroundColor

setBackgroundColor

getForegroundColor

setForegroundColor

getHidden

setHidden

getSelected

setSelected

getAccessRole

getDefaultReminders

setDefaultReminders

getNotificationSettings

setNotificationSettings

getPrimary

setPrimary

toString