org.springframework.social.google.api.calendar

Interface CalendarListQueryBuilder

All Superinterfaces:

ApiQueryBuilder<CalendarListQueryBuilder,CalendarPage>, QueryBuilder<CalendarListQueryBuilder,CalendarPage>

All Known Implementing Classes:

CalendarListQueryBuilderImpl

public interface CalendarListQueryBuilder
extends ApiQueryBuilder<CalendarListQueryBuilder,CalendarPage>

Constructs queries for listing the accessible calendars, following the builder pattern. The ApiQueryBuilder.getPage() method returns a CalendarPage containing Calendar instances.

See the reference documentation at http://developers.google.com/google-apps/calendar/v3/reference/calendarList/list for details of the parameters.

Method Summary

Modifier and Type	Method and Description
CalendarListQueryBuilder	minAccessRole(PermissionRole minAccessRole) The minimum access role for the user in the returned entries.
CalendarListQueryBuilder	showDeleted(boolean showDeleted) Whether to include deleted calendar list entries in the result.
CalendarListQueryBuilder	showHidden(boolean showHidden) Whether to show hidden entries.

Methods inherited from interface org.springframework.social.google.api.query.ApiQueryBuilder

fromPage, getPage

Methods inherited from interface org.springframework.social.google.api.query.QueryBuilder

maxResultsNumber

Method Detail

minAccessRole

CalendarListQueryBuilder minAccessRole(PermissionRole minAccessRole)

The minimum access role for the user in the returned entries. Optional. The default is no restriction.

Parameters:

minAccessRole - the minimum access role for the user in the returned entries.

Returns:

this CalendarListQueryBuilder, for refining the query.

showDeleted

CalendarListQueryBuilder showDeleted(boolean showDeleted)

Whether to include deleted calendar list entries in the result. Optional. The default is false.

Parameters:

showDeleted - whether to include deleted calendar list entries in the result.

Returns:

this CalendarListQueryBuilder, for refining the query.

showHidden

CalendarListQueryBuilder showHidden(boolean showHidden)

Whether to show hidden entries. Optional. The default is false.

Parameters:

showHidden - whether to show hidden entries.

Returns:

this CalendarListQueryBuilder, for refining the query.