Search Results for

    Show / Hide Table of Contents

    Class CreateTransferRequest

    Creates a transfer.

    Inheritance
    object
    CreateTransferRequest
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class CreateTransferRequest

    Properties

    CollectionName

    Name of collection created after transfer.

    Declaration
    [JsonProperty("collectionName", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string CollectionName { get; set; }
    Property Value
    string

    CreateCollection

    A value indicating whether to create a collection after importing the transfer.

    Declaration
    [JsonProperty("createCollection", Required = Required.Always)]
    public bool CreateCollection { get; set; }
    Property Value
    bool

    Files

    Files uploaded in transfer.
    The client is responsible for uploading files to backend.
    Required when TransferType is FileUpload or FileUploadAutoImport.

    Declaration
    [JsonProperty("files", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<TransferUploadFile> Files { get; set; }
    Property Value
    ICollection<TransferUploadFile>

    Name

    Name of transfer.

    Declaration
    [JsonProperty("name", Required = Required.Always)]
    [Required]
    public string Name { get; set; }
    Property Value
    string

    TransferType

    Type of transfer.

    Declaration
    [JsonProperty("transferType", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    [JsonConverter(typeof(StringEnumConverter))]
    public TransferType TransferType { get; set; }
    Property Value
    TransferType

    WebLinks

    Weblinks downloaded in transfer.
    The backend will download files using HTTP, therefore public access to files is needed.
    Required when TransferType is WebDownload.

    Declaration
    [JsonProperty("webLinks", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<TransferWebLink> WebLinks { get; set; }
    Property Value
    ICollection<TransferWebLink>

    Methods

    FromJson(string)

    Declaration
    public static CreateTransferRequest FromJson(string data)
    Parameters
    string data

    Returns
    CreateTransferRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX