C# Class Transloadit.Assembly.AssemblyBuilder

Builds up an assembly which will be tried to be created on Transloadit
Inheritance: IAssemblyBuilder
显示文件 Open project: nkranitz/transloadit-csharp-sdk Class Usage Examples

Protected Properties

Property Type Description
auth string>.Dictionary
fields object>.Dictionary
fileIncrement int
files string>.Dictionary
notifyURL string
signature string
steps Dictionary>
templateID string

Public Methods

Method Description
AddFile ( string path ) : void

Adds file to the current assembly

AddFile ( string key, string path ) : void

Adds file to the current assembly with specific key

AddStep ( string name, IStep step ) : void

Adds step to the current assembly

AssemblyBuilder ( ) : System

Creates a new TransloaditAssemblyBuilder object; sets steps, auth and files to empty collections

GetParams ( ) : object>.Dictionary

Generates and gets the parameter tree of an assembly

HasNotifyUrl ( ) : bool

Checks whether the assembly has notify URL

HasSteps ( ) : bool

Checks whether the assembly has steps

HasTemplateID ( ) : bool

Checks whether the assembly has template ID

SetAuthExpires ( System.DateTime dateTime ) : void

Sets the expiration datetime of the assembly (as UTC date)

SetAuthKey ( string key ) : void

Sets the authentication key for the assembly

SetAuthMaxSize ( int maxSize ) : void

Sets the maximum size of the assembly

SetField ( string key, object value ) : void

Sets a custom field in the current assembly

SetNotifyURL ( string notifyURL ) : void

Sets the notification URL of the assembly, which will be requested after assembly is completed

SetTemplateID ( string templateID ) : void

Sets the used template ID of the assmebly (you can create multiple Transloadit templates under your account,please use its unique ID here)

ToApiData ( ) : ApiData

Converts the builder to ApiData and gets the object, which will be the base of the sent Transloadit request

ToJsonString ( ) : string

Converts the builder to JSON string and gets it

Protected Methods

Method Description
ValidateKey ( string key ) : void

Validates the passed key

Method Details

AddFile() public method

Adds file to the current assembly
public AddFile ( string path ) : void
path string Path of the file
return void

AddFile() public method

Adds file to the current assembly with specific key
/// Thrown when an invalid (reserved) field key is tried to be used ///
public AddFile ( string key, string path ) : void
key string Key of the file to be uploaded
path string Path of the file
return void

AddStep() public method

Adds step to the current assembly
public AddStep ( string name, IStep step ) : void
name string Name of the step
step IStep Step to be added
return void

AssemblyBuilder() public method

Creates a new TransloaditAssemblyBuilder object; sets steps, auth and files to empty collections
public AssemblyBuilder ( ) : System
return System

GetParams() public method

Generates and gets the parameter tree of an assembly
public GetParams ( ) : object>.Dictionary
return object>.Dictionary

HasNotifyUrl() public method

Checks whether the assembly has notify URL
public HasNotifyUrl ( ) : bool
return bool

HasSteps() public method

Checks whether the assembly has steps
public HasSteps ( ) : bool
return bool

HasTemplateID() public method

Checks whether the assembly has template ID
public HasTemplateID ( ) : bool
return bool

SetAuthExpires() public method

Sets the expiration datetime of the assembly (as UTC date)
public SetAuthExpires ( System.DateTime dateTime ) : void
dateTime System.DateTime Expiration datetime
return void

SetAuthKey() public method

Sets the authentication key for the assembly
public SetAuthKey ( string key ) : void
key string API key of the user
return void

SetAuthMaxSize() public method

Sets the maximum size of the assembly
public SetAuthMaxSize ( int maxSize ) : void
maxSize int Maximum size (in bytes)
return void

SetField() public method

Sets a custom field in the current assembly
/// Thrown when an invalid (reserved) field key is tried to be used /// /// Thrown when an already defined key (in files or in fields) is tried to be used ///
public SetField ( string key, object value ) : void
key string Key of the field
value object Value of the field
return void

SetNotifyURL() public method

Sets the notification URL of the assembly, which will be requested after assembly is completed
public SetNotifyURL ( string notifyURL ) : void
notifyURL string Notification URL (e.g.: 'http://my.domain.me/application')
return void

SetTemplateID() public method

Sets the used template ID of the assmebly (you can create multiple Transloadit templates under your account,please use its unique ID here)
public SetTemplateID ( string templateID ) : void
templateID string Template ID of the assmebly
return void

ToApiData() public method

Converts the builder to ApiData and gets the object, which will be the base of the sent Transloadit request
public ToApiData ( ) : ApiData
return ApiData

ToJsonString() public method

Converts the builder to JSON string and gets it
public ToJsonString ( ) : string
return string

ValidateKey() protected method

Validates the passed key
/// Thrown when an invalid (reserved) field key is tried to be used ///
protected ValidateKey ( string key ) : void
key string Key to be validated
return void

Property Details

auth protected_oe property

Authentication information
protected Dictionary auth
return string>.Dictionary

fields protected_oe property

Collection of custom fields
protected Dictionary fields
return object>.Dictionary

fileIncrement protected_oe property

File increment value to store the index of the files to be uploaded which have auto generated key
protected int fileIncrement
return int

files protected_oe property

Collection of the files to be sent
protected Dictionary files
return string>.Dictionary

notifyURL protected_oe property

Notification URL, proceed after assembly was completed
protected string notifyURL
return string

signature protected_oe property

Signature of the current assembly
protected string signature
return string

steps protected_oe property

Steps in the assembly
protected Dictionary> steps
return Dictionary>

templateID protected_oe property

Used template ID
protected string templateID
return string