C# Класс CloudinaryDotNet.Actions.ArchiveParams

Parameters for working with archives, common for both of the methods (create and download)
Наследование: BaseParams
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
Async ( bool async ) : ArchiveParams

Set whether to perform the archive generation in the background (asynchronously). Default: false. Relevant only for create call.
Check ( ) : void

Validate object model
ExpiresAt ( int expiresAt ) : ArchiveParams

Set the Unix time in seconds when the generated download URL expires (e.g., 1415060076). If this parameter is omitted then the generated download URL expires after 1 hour. Note: Relevant only for download call.
ExpiresAt ( ) : int

Get the Unix time in seconds when the generated download URL expires.
FlattenFolders ( bool flattenFolders ) : ArchiveParams

Determines whether to flatten all files to be in the root of the archive file (no sub-folders).
FlattenTransformations ( bool flattenTransformations ) : ArchiveParams

Determines whether to flatten the folder structure of the derived images and store the transformation details on the file name instead.
IsAsync ( ) : bool

Get whether to perform the archive generation in the background (asynchronously).
IsFlattenFolders ( ) : bool

Get whether to flatten all files to be in the root of the archive file (no sub-folders).
IsFlattenTransformations ( ) : bool

Get whether to flatten the folder structure of the derived images and store the transformation details on the file name instead.
IsKeepDerived ( ) : bool

Get whether to keep the derived images used for generating the archive or not.
IsUseOriginalFilename ( ) : bool

Get whether to use the original file name of the included images (if available) instead of the Public ID.
KeepDerived ( bool keepDerived ) : ArchiveParams

Set whether to keep the derived images used for generating the archive or not.
Mode ( ) : ArchiveCallMode

Get Mode whether to return the generated archive file (download) or to store it as a raw resource (create)
Mode ( ArchiveCallMode mode ) : ArchiveParams

Determines whether to return the generated archive file (download) or to store it as a raw resource in your Cloudinary account and return a JSON with the URLs for accessing the archive file (create)
NotificationUrl ( string notificationUrl ) : ArchiveParams

Set an HTTP or HTTPS URL to notify your application (a webhook) when the process has completed.
NotificationUrl ( ) : string

Get an HTTP or HTTPS URL to notify your application (a webhook) when the process has completed.
Prefixes ( List prefixes ) : ArchiveParams

Set a list of prefixes of Public IDs (e.g., folders). All images with this tag(s) will be included in the archive. Setting this parameter to a slash (/) is a shortcut for including all images in the account for the given resource type and type (up to the max files limit).
Prefixes ( ) : List

Get a list of prefixes of Public IDs (e.g., folders).
PublicIds ( List publicIds ) : ArchiveParams

Set a list of Public IDs for the specific images to be included in the archive
PublicIds ( ) : List

Get a list of Public IDs for the specific images to be included in the archive
ResourceType ( string resourceType ) : ArchiveParams

Set the resource type (image, video or raw) of files to include in the archive: Default: image.
ResourceType ( ) : string

Get the resource type (image, video or raw) of files to include in the archive.
Tags ( List tags ) : ArchiveParams

Set a list of tag names. All images with this tag(s) will be included in the archive
Tags ( ) : List

Get a list of tag names. All images with this tag(s) will be included in the archive
TargetFormat ( ) : ArchiveFormat

Get the format for the generated archive.
TargetFormat ( ArchiveFormat targetFormat ) : ArchiveParams

Set the format for the generated archive. Currently only 'zip' is supported.
TargetPublicId ( string targetPublicId ) : ArchiveParams

Set the Public ID to assign to the generated archive. relevant only for create call.
TargetPublicId ( ) : string

Get the Public ID to assign to the generated archive.
TargetTags ( List targetTags ) : ArchiveParams

Set a list of tag names to assign to the generated archive. Relevant only for create call.
TargetTags ( ) : List

Get a list of tag names to assign to the generated archive.
ToParamsDictionary ( ) : object>.SortedDictionary

Maps object model to dictionary of parameters in cloudinary notation
Transformations ( List transformations ) : ArchiveParams

Set a list of transformations to apply to the images before they are included in the generated archive.
Transformations ( ) : List

Get a list of transformations applied to the images before they are included in the generated archive.
Type ( string type ) : ArchiveParams

Set the specific file type of resources to include in the archive (upload/private/authenticated). Default: upload.
Type ( ) : string

Get the specific file type of resources to include in the archive (upload/private/authenticated).
UseOriginalFilename ( bool useOriginalFilename ) : ArchiveParams

Set whether to use the original file name of the included images (if available) instead of the Public ID.

Описание методов

Async() публичный Метод

Set whether to perform the archive generation in the background (asynchronously). Default: false. Relevant only for create call.
public Async ( bool async ) : ArchiveParams
async bool
Результат ArchiveParams

Check() публичный Метод

Validate object model
public Check ( ) : void
Результат void

ExpiresAt() публичный Метод

Set the Unix time in seconds when the generated download URL expires (e.g., 1415060076). If this parameter is omitted then the generated download URL expires after 1 hour. Note: Relevant only for download call.
public ExpiresAt ( int expiresAt ) : ArchiveParams
expiresAt int
Результат ArchiveParams

ExpiresAt() публичный Метод

Get the Unix time in seconds when the generated download URL expires.
public ExpiresAt ( ) : int
Результат int

FlattenFolders() публичный Метод

Determines whether to flatten all files to be in the root of the archive file (no sub-folders).
public FlattenFolders ( bool flattenFolders ) : ArchiveParams
flattenFolders bool
Результат ArchiveParams

FlattenTransformations() публичный Метод

Determines whether to flatten the folder structure of the derived images and store the transformation details on the file name instead.
public FlattenTransformations ( bool flattenTransformations ) : ArchiveParams
flattenTransformations bool
Результат ArchiveParams

IsAsync() публичный Метод

Get whether to perform the archive generation in the background (asynchronously).
public IsAsync ( ) : bool
Результат bool

IsFlattenFolders() публичный Метод

Get whether to flatten all files to be in the root of the archive file (no sub-folders).
public IsFlattenFolders ( ) : bool
Результат bool

IsFlattenTransformations() публичный Метод

Get whether to flatten the folder structure of the derived images and store the transformation details on the file name instead.
public IsFlattenTransformations ( ) : bool
Результат bool

IsKeepDerived() публичный Метод

Get whether to keep the derived images used for generating the archive or not.
public IsKeepDerived ( ) : bool
Результат bool

IsUseOriginalFilename() публичный Метод

Get whether to use the original file name of the included images (if available) instead of the Public ID.
public IsUseOriginalFilename ( ) : bool
Результат bool

KeepDerived() публичный Метод

Set whether to keep the derived images used for generating the archive or not.
public KeepDerived ( bool keepDerived ) : ArchiveParams
keepDerived bool
Результат ArchiveParams

Mode() публичный Метод

Get Mode whether to return the generated archive file (download) or to store it as a raw resource (create)
public Mode ( ) : ArchiveCallMode
Результат ArchiveCallMode

Mode() публичный Метод

Determines whether to return the generated archive file (download) or to store it as a raw resource in your Cloudinary account and return a JSON with the URLs for accessing the archive file (create)
public Mode ( ArchiveCallMode mode ) : ArchiveParams
mode ArchiveCallMode
Результат ArchiveParams

NotificationUrl() публичный Метод

Set an HTTP or HTTPS URL to notify your application (a webhook) when the process has completed.
public NotificationUrl ( string notificationUrl ) : ArchiveParams
notificationUrl string
Результат ArchiveParams

NotificationUrl() публичный Метод

Get an HTTP or HTTPS URL to notify your application (a webhook) when the process has completed.
public NotificationUrl ( ) : string
Результат string

Prefixes() публичный Метод

Set a list of prefixes of Public IDs (e.g., folders). All images with this tag(s) will be included in the archive. Setting this parameter to a slash (/) is a shortcut for including all images in the account for the given resource type and type (up to the max files limit).
public Prefixes ( List prefixes ) : ArchiveParams
prefixes List
Результат ArchiveParams

Prefixes() публичный Метод

Get a list of prefixes of Public IDs (e.g., folders).
public Prefixes ( ) : List
Результат List

PublicIds() публичный Метод

Set a list of Public IDs for the specific images to be included in the archive
public PublicIds ( List publicIds ) : ArchiveParams
publicIds List
Результат ArchiveParams

PublicIds() публичный Метод

Get a list of Public IDs for the specific images to be included in the archive
public PublicIds ( ) : List
Результат List

ResourceType() публичный Метод

Set the resource type (image, video or raw) of files to include in the archive: Default: image.
public ResourceType ( string resourceType ) : ArchiveParams
resourceType string
Результат ArchiveParams

ResourceType() публичный Метод

Get the resource type (image, video or raw) of files to include in the archive.
public ResourceType ( ) : string
Результат string

Tags() публичный Метод

Set a list of tag names. All images with this tag(s) will be included in the archive
public Tags ( List tags ) : ArchiveParams
tags List
Результат ArchiveParams

Tags() публичный Метод

Get a list of tag names. All images with this tag(s) will be included in the archive
public Tags ( ) : List
Результат List

TargetFormat() публичный Метод

Get the format for the generated archive.
public TargetFormat ( ) : ArchiveFormat
Результат ArchiveFormat

TargetFormat() публичный Метод

Set the format for the generated archive. Currently only 'zip' is supported.
public TargetFormat ( ArchiveFormat targetFormat ) : ArchiveParams
targetFormat ArchiveFormat
Результат ArchiveParams

TargetPublicId() публичный Метод

Set the Public ID to assign to the generated archive. relevant only for create call.
public TargetPublicId ( string targetPublicId ) : ArchiveParams
targetPublicId string
Результат ArchiveParams

TargetPublicId() публичный Метод

Get the Public ID to assign to the generated archive.
public TargetPublicId ( ) : string
Результат string

TargetTags() публичный Метод

Set a list of tag names to assign to the generated archive. Relevant only for create call.
public TargetTags ( List targetTags ) : ArchiveParams
targetTags List
Результат ArchiveParams

TargetTags() публичный Метод

Get a list of tag names to assign to the generated archive.
public TargetTags ( ) : List
Результат List

ToParamsDictionary() публичный Метод

Maps object model to dictionary of parameters in cloudinary notation
public ToParamsDictionary ( ) : object>.SortedDictionary
Результат object>.SortedDictionary

Transformations() публичный Метод

Set a list of transformations to apply to the images before they are included in the generated archive.
public Transformations ( List transformations ) : ArchiveParams
transformations List
Результат ArchiveParams

Transformations() публичный Метод

Get a list of transformations applied to the images before they are included in the generated archive.
public Transformations ( ) : List
Результат List

Type() публичный Метод

Set the specific file type of resources to include in the archive (upload/private/authenticated). Default: upload.
public Type ( string type ) : ArchiveParams
type string
Результат ArchiveParams

Type() публичный Метод

Get the specific file type of resources to include in the archive (upload/private/authenticated).
public Type ( ) : string
Результат string

UseOriginalFilename() публичный Метод

Set whether to use the original file name of the included images (if available) instead of the Public ID.
public UseOriginalFilename ( bool useOriginalFilename ) : ArchiveParams
useOriginalFilename bool
Результат ArchiveParams