Class CalendarListResource.ListRequest

Returns the calendars on the user's calendar list.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<CalendarList>
CalendarBaseServiceRequest<CalendarList>
CalendarListResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Calendar.v3
Assembly: Google.Apis.Calendar.v3.dll
Syntax
public class CalendarListResource.ListRequest : CalendarBaseServiceRequest<CalendarList>, IClientServiceRequest<CalendarList>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MaxResults

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.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

MinAccessRole

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

Declaration
[RequestParameter("minAccessRole", RequestParameterType.Query)]
public virtual CalendarListResource.ListRequest.MinAccessRoleEnum? MinAccessRole { get; set; }
Property Value
Type Description
CalendarListResource.ListRequest.MinAccessRoleEnum?

PageToken

Token specifying which result page to return. Optional.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ShowDeleted

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

Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual bool? ShowDeleted { get; set; }
Property Value
Type Description
bool?

ShowHidden

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

Declaration
[RequestParameter("showHidden", RequestParameterType.Query)]
public virtual bool? ShowHidden { get; set; }
Property Value
Type Description
bool?

SyncToken

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.

Declaration
[RequestParameter("syncToken", RequestParameterType.Query)]
public virtual string SyncToken { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements