C# Класс Transloadit.Assembly.AssemblyBuilder

Builds up an assembly which will be tried to be created on Transloadit

Наследование: IAssemblyBuilder

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
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