Show / Hide Table of Contents

Class CommitInfo

The commit info object

Inheritance
System.Object
CommitInfo
UploadArg
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Dropbox.Api.Files
Assembly: Dropbox.Api.dll
Syntax
public class CommitInfo

Constructors

| Improve this Doc View Source

CommitInfo(String, WriteMode, Boolean, Nullable<DateTime>, Boolean, IEnumerable<PropertyGroup>, Boolean)

Initializes a new instance of the CommitInfo class.

Declaration
public CommitInfo(string path, WriteMode mode = null, bool autorename = false, DateTime? clientModified = null, bool mute = false, IEnumerable<PropertyGroup> propertyGroups = null, bool strictConflict = false)
Parameters
Type Name Description
System.String path

Path in the user's Dropbox to save the file.

WriteMode mode

Selects what to do if the file already exists.

System.Boolean autorename

If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.

System.Nullable<System.DateTime> clientModified

The value to store as the clientModified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.

System.Boolean mute

Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.

System.Collections.Generic.IEnumerable<PropertyGroup> propertyGroups

List of custom properties to add to file.

System.Boolean strictConflict

Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.Update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

Properties

| Improve this Doc View Source

Autorename

If there's a conflict, as determined by Mode, have the Dropbox server try to autorename the file to avoid conflict.

Declaration
public bool Autorename { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ClientModified

The value to store as the ClientModified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.

Declaration
public DateTime? ClientModified { get; protected set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

Mode

Selects what to do if the file already exists.

Declaration
public WriteMode Mode { get; protected set; }
Property Value
Type Description
WriteMode
| Improve this Doc View Source

Mute

Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.

Declaration
public bool Mute { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Path

Path in the user's Dropbox to save the file.

Declaration
public string Path { get; protected set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PropertyGroups

List of custom properties to add to file.

Declaration
public IList<PropertyGroup> PropertyGroups { get; protected set; }
Property Value
Type Description
System.Collections.Generic.IList<PropertyGroup>
| Improve this Doc View Source

StrictConflict

Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when Mode = WriteMode.Update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

Declaration
public bool StrictConflict { get; protected set; }
Property Value
Type Description
System.Boolean

See Also

GetTemporaryUploadLinkArg
UploadArg
UploadSessionFinishArg
  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • CommitInfo(String, WriteMode, Boolean, Nullable<DateTime>, Boolean, IEnumerable<PropertyGroup>, Boolean)
  • Properties
    • Autorename
    • ClientModified
    • Mode
    • Mute
    • Path
    • PropertyGroups
    • StrictConflict
  • See Also
Back to top Generated by DocFX