C# Class CloudinaryDotNet.Actions.ArchiveParams

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

Méthodes publiques

Méthode 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 méthode

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
Résultat ArchiveParams

Check() public méthode

Validate object model
public Check ( ) : void
Résultat void

ExpiresAt() public méthode

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
Résultat ArchiveParams

ExpiresAt() public méthode

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

FlattenFolders() public méthode

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
Résultat ArchiveParams

FlattenTransformations() public méthode

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
Résultat ArchiveParams

IsAsync() public méthode

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

IsFlattenFolders() public méthode

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

IsFlattenTransformations() public méthode

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

IsKeepDerived() public méthode

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

IsUseOriginalFilename() public méthode

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

KeepDerived() public méthode

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

Mode() public méthode

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

Mode() public méthode

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
Résultat ArchiveParams

NotificationUrl() public méthode

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

NotificationUrl() public méthode

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

Prefixes() public méthode

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
Résultat ArchiveParams

Prefixes() public méthode

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

PublicIds() public méthode

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

PublicIds() public méthode

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

ResourceType() public méthode

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

ResourceType() public méthode

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

Tags() public méthode

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
Résultat ArchiveParams

Tags() public méthode

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

TargetFormat() public méthode

Get the format for the generated archive.
public TargetFormat ( ) : ArchiveFormat
Résultat ArchiveFormat

TargetFormat() public méthode

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

TargetPublicId() public méthode

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

TargetPublicId() public méthode

Get the Public ID to assign to the generated archive.
public TargetPublicId ( ) : string
Résultat string

TargetTags() public méthode

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

TargetTags() public méthode

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

ToParamsDictionary() public méthode

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

Transformations() public méthode

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
Résultat ArchiveParams

Transformations() public méthode

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

Type() public méthode

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

Type() public méthode

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

UseOriginalFilename() public méthode

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
Résultat ArchiveParams