C# Class CloudinaryDotNet.Actions.ArchiveParams

Parameters for working with archives, common for both of the methods (create and download)
Inheritance: BaseParams
Show file Open project: cloudinary/CloudinaryDotNet Class Usage Examples

Public Methods

Method Description
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.

Method Details

Async() public method

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
return ArchiveParams

Check() public method

Validate object model
public Check ( ) : void
return void

ExpiresAt() public method

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
return ArchiveParams

ExpiresAt() public method

Get the Unix time in seconds when the generated download URL expires.
public ExpiresAt ( ) : int
return int

FlattenFolders() public method

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
return ArchiveParams

FlattenTransformations() public method

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
return ArchiveParams

IsAsync() public method

Get whether to perform the archive generation in the background (asynchronously).
public IsAsync ( ) : bool
return bool

IsFlattenFolders() public method

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

IsFlattenTransformations() public method

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

IsKeepDerived() public method

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

IsUseOriginalFilename() public method

Get whether to use the original file name of the included images (if available) instead of the Public ID.
public IsUseOriginalFilename ( ) : bool
return bool

KeepDerived() public method

Set whether to keep the derived images used for generating the archive or not.
public KeepDerived ( bool keepDerived ) : ArchiveParams
keepDerived bool
return ArchiveParams

Mode() public method

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

Mode() public method

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
return ArchiveParams

NotificationUrl() public method

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

NotificationUrl() public method

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

Prefixes() public method

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
return ArchiveParams

Prefixes() public method

Get a list of prefixes of Public IDs (e.g., folders).
public Prefixes ( ) : List
return List

PublicIds() public method

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

PublicIds() public method

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

ResourceType() public method

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

ResourceType() public method

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

Tags() public method

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
return ArchiveParams

Tags() public method

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

TargetFormat() public method

Get the format for the generated archive.
public TargetFormat ( ) : ArchiveFormat
return ArchiveFormat

TargetFormat() public method

Set the format for the generated archive. Currently only 'zip' is supported.
public TargetFormat ( ArchiveFormat targetFormat ) : ArchiveParams
targetFormat ArchiveFormat
return ArchiveParams

TargetPublicId() public method

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

TargetPublicId() public method

Get the Public ID to assign to the generated archive.
public TargetPublicId ( ) : string
return string

TargetTags() public method

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

TargetTags() public method

Get a list of tag names to assign to the generated archive.
public TargetTags ( ) : List
return List

ToParamsDictionary() public method

Maps object model to dictionary of parameters in cloudinary notation
public ToParamsDictionary ( ) : object>.SortedDictionary
return object>.SortedDictionary

Transformations() public method

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
return ArchiveParams

Transformations() public method

Get a list of transformations applied to the images before they are included in the generated archive.
public Transformations ( ) : List
return List

Type() public method

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

Type() public method

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

UseOriginalFilename() public method

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
return ArchiveParams