C# 클래스 Transloadit.Assembly.AssemblyBuilder

Builds up an assembly which will be tried to be created on Transloadit
상속: IAssemblyBuilder
파일 보기 프로젝트 열기: nkranitz/transloadit-csharp-sdk 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
auth string>.Dictionary
fields object>.Dictionary
fileIncrement int
files string>.Dictionary
notifyURL string
signature string
steps Dictionary>
templateID string

공개 메소드들

메소드 설명
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

보호된 메소드들

메소드 설명
ValidateKey ( string key ) : void

Validates the passed key

메소드 상세

AddFile() 공개 메소드

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

AddFile() 공개 메소드

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
리턴 void

AddStep() 공개 메소드

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
리턴 void

AssemblyBuilder() 공개 메소드

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

GetParams() 공개 메소드

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

HasNotifyUrl() 공개 메소드

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

HasSteps() 공개 메소드

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

HasTemplateID() 공개 메소드

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

SetAuthExpires() 공개 메소드

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

SetAuthKey() 공개 메소드

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

SetAuthMaxSize() 공개 메소드

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

SetField() 공개 메소드

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
리턴 void

SetNotifyURL() 공개 메소드

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')
리턴 void

SetTemplateID() 공개 메소드

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
리턴 void

ToApiData() 공개 메소드

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

ToJsonString() 공개 메소드

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

ValidateKey() 보호된 메소드

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
리턴 void

프로퍼티 상세

auth 보호되어 있는 프로퍼티

Authentication information
protected Dictionary auth
리턴 string>.Dictionary

fields 보호되어 있는 프로퍼티

Collection of custom fields
protected Dictionary fields
리턴 object>.Dictionary

fileIncrement 보호되어 있는 프로퍼티

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

files 보호되어 있는 프로퍼티

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

notifyURL 보호되어 있는 프로퍼티

Notification URL, proceed after assembly was completed
protected string notifyURL
리턴 string

signature 보호되어 있는 프로퍼티

Signature of the current assembly
protected string signature
리턴 string

steps 보호되어 있는 프로퍼티

Steps in the assembly
protected Dictionary> steps
리턴 Dictionary>

templateID 보호되어 있는 프로퍼티

Used template ID
protected string templateID
리턴 string