Google.Apis.Calendar.v3.CalendarListResource.ListRequest Class Reference

Returns entries on the user's calendar list. More...

Inheritance diagram for Google.Apis.Calendar.v3.CalendarListResource.ListRequest:

Public Types
enum	MinAccessRoleEnum
	The minimum access role for the user in the returned entires. Optional. The default is no restriction. More...
Public Types inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
enum	AltEnum
	Data format for the response. More...

Public Member Functions
	ListRequest (Google.Apis.Services.IClientService service)
	Constructs a new List request.

Protected Member Functions
override void	InitParameters ()
	Initializes List parameter list.
Protected Member Functions inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
	CalendarBaseServiceRequest (Google.Apis.Services.IClientService service)
	Constructs a new CalendarBaseServiceRequest instance.
Protected Member Functions inherited from Google::Apis::Requests::ClientServiceRequest-g< class >
	ClientServiceRequest (IClientService service)
string	GenerateRequestUri ()
virtual object	GetBody ()

Properties
virtual string	SyncToken [get, set]
	Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
virtual System.Nullable< bool >	ShowDeleted [get, set]
	Whether to include deleted calendar list entries in the result. Optional. The default is False.
virtual System.Nullable < MinAccessRoleEnum >	MinAccessRole [get, set]
	The minimum access role for the user in the returned entires. Optional. The default is no restriction.
virtual System.Nullable< int >	MaxResults [get, set]
	Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
virtual string	PageToken [get, set]
	Token specifying which result page to return. Optional.
virtual System.Nullable< bool >	ShowHidden [get, set]
	Whether to show hidden entries. Optional. The default is False.
override string	MethodName [get]
	summary>Gets the HTTP method.
override string	HttpMethod [get]
	summary>Gets the REST path.
override string	RestPath [get]
Properties inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
virtual System.Nullable< AltEnum >	Alt [get, set]
	Data format for the response.
virtual string	Fields [get, set]
	Selector specifying which fields to include in a partial response.
virtual string	Key [get, set]
	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
virtual string	OauthToken [get, set]
	OAuth 2.0 token for the current user.
virtual System.Nullable< bool >	PrettyPrint [get, set]
	Returns response with indentations and line breaks.
virtual string	QuotaUser [get, set]
	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
virtual string	UserIp [get, set]
	IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Properties inherited from Google::Apis::Requests::ClientServiceRequest-g< class >
ETagAction	ETagAction
abstract string	MethodName
abstract string	RestPath
abstract string	HttpMethod
IDictionary< string, IParameter >	RequestParameters
IClientService	Service
Properties inherited from Google::Apis::Requests::IClientServiceRequest
string	MethodName
string	RestPath
string	HttpMethod
IDictionary< string, IParameter >	RequestParameters
IClientService	Service

Detailed Description

Returns entries on the user's calendar list.

Member Enumeration Documentation

enum Google.Apis.Calendar.v3.CalendarListResource.ListRequest.MinAccessRoleEnum

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

Constructor & Destructor Documentation

Google.Apis.Calendar.v3.CalendarListResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service )

inline

Constructs a new List request.

Member Function Documentation

override void Google.Apis.Calendar.v3.CalendarListResource.ListRequest.InitParameters ( )

inlineprotectedvirtual

Initializes List parameter list.

Reimplemented from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >.

Property Documentation

override string Google.Apis.Calendar.v3.CalendarListResource.ListRequest.HttpMethod

get

summary>Gets the REST path.

virtual System.Nullable<int> Google.Apis.Calendar.v3.CalendarListResource.ListRequest.MaxResults

getset

Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

[minimum: 1]

override string Google.Apis.Calendar.v3.CalendarListResource.ListRequest.MethodName

get

summary>Gets the HTTP method.

virtual System.Nullable<MinAccessRoleEnum> Google.Apis.Calendar.v3.CalendarListResource.ListRequest.MinAccessRole

getset

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

virtual string Google.Apis.Calendar.v3.CalendarListResource.ListRequest.PageToken

getset

Token specifying which result page to return. Optional.

virtual System.Nullable<bool> Google.Apis.Calendar.v3.CalendarListResource.ListRequest.ShowDeleted

getset

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

virtual System.Nullable<bool> Google.Apis.Calendar.v3.CalendarListResource.ListRequest.ShowHidden

getset

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

summary>Gets the method name.

virtual string Google.Apis.Calendar.v3.CalendarListResource.ListRequest.SyncToken

getset

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

---

The documentation for this class was generated from the following file:

• Google.Apis.Calendar.v3.cs