Class UsersResource.HistoryResource.ListRequest
Lists the history of all changes to the given mailbox. History results are returned in chronological
order (increasing historyId).
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Gmail.v1
Assembly: Google.Apis.Gmail.v1.dll
Syntax
public class ListRequest : GmailBaseServiceRequest<ListHistoryResponse>, IClientServiceRequest<ListHistoryResponse>, IClientServiceRequestConstructors
ListRequest(IClientService, String)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string userId)Parameters
| Type | Name | Description |
|---|---|---|
| Google.Apis.Services.IClientService | service | |
| System.String | userId |
Properties
HistoryTypes
History types to be returned by the function
Declaration
[RequestParameter("historyTypes", RequestParameterType.Query)]
public virtual UsersResource.HistoryResource.ListRequest.HistoryTypesEnum? HistoryTypes { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<UsersResource.HistoryResource.ListRequest.HistoryTypesEnum> |
Remarks
Use this property to set a single value for the parameter, or HistoryTypesList to set multiple values. Do not set both properties.
HistoryTypesList
History types to be returned by the function
Declaration
[RequestParameter("historyTypes", RequestParameterType.Query)]
public virtual Repeatable<UsersResource.HistoryResource.ListRequest.HistoryTypesEnum> HistoryTypesList { get; set; }Property Value
| Type | Description |
|---|---|
| Google.Apis.Util.Repeatable<UsersResource.HistoryResource.ListRequest.HistoryTypesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and HistoryTypes.
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
LabelId
Only return messages with a label matching the ID.
Declaration
[RequestParameter("labelId", RequestParameterType.Query)]
public virtual string LabelId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
MaxResults
Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
PageToken
Page token to retrieve a specific page of results in the list.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
StartHistoryId
Required. Returns history records after the specified startHistoryId. The supplied
startHistoryId should be obtained from the historyId of a message, thread, or previous list
response. History IDs increase chronologically but are not contiguous with random gaps in between
valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404
error code. A historyId is typically valid for at least a week, but in some rare circumstances may
be valid for only a few hours. If you receive an HTTP 404 error response, your application should
perform a full sync. If you receive no nextPageToken in the response, there are no updates to
retrieve and you can store the returned historyId for a future request.
Declaration
[RequestParameter("startHistoryId", RequestParameterType.Query)]
public virtual ulong? StartHistoryId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.UInt64> |
UserId
The user's email address. The special value me can be used to indicate the authenticated user.
Declaration
[RequestParameter("userId", RequestParameterType.Path)]
public virtual string UserId { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()