Search Results for

Show / Hide Table of Contents

# Class UploadResult

Represents the server response returned after an upload, chunk operation, or validation-related failure.

##### Inheritance

object
UploadResult

##### Inherited Members

object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: CoreUpload.Models

###### Assembly: CoreUpload.dll

##### Syntax

    public class UploadResult

### Properties

#### ErrorMessage

Gets or sets the human-readable error message when the operation fails.

##### Declaration

    public string? ErrorMessage { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### FileGuid

Gets or sets the GUID assigned to the stored file when the operation creates or finalizes an upload.

##### Declaration

    public Guid? FileGuid { get; set; }

##### Property Value

Type | Description
--- | ---
Guid? |

#### FileName

Gets or sets the original file name associated with the operation.

##### Declaration

    public string? FileName { get; set; }

##### Property Value

Type | Description
--- | ---
string |

#### FileSize

Gets or sets the stored file size in bytes.

##### Declaration

    public long FileSize { get; set; }

##### Property Value

Type | Description
--- | ---
long |

#### Success

Gets or sets a value indicating whether the operation succeeded.

##### Declaration

    public bool Success { get; set; }

##### Property Value

Type | Description
--- | ---
bool |

### Methods

#### Error(string)

Creates a failed upload result with the supplied error message.

##### Declaration

    public static UploadResult Error(string message)

##### Parameters

Type | Name | Description
--- | --- | ---
string | message |

##### Returns

Type | Description
--- | ---
UploadResult |

#### Ok(Guid, string, long)

Creates a successful upload result.

##### Declaration

    public static UploadResult Ok(Guid guid, string fileName, long fileSize)

##### Parameters

Type | Name | Description
--- | --- | ---
Guid | guid |
string | fileName |
long | fileSize |

##### Returns

Type | Description
--- | ---
UploadResult |