dotmailer SDK: dotMailer.Sdk.Objects.Images.DmImageFolder Class Reference

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
dotMailer.Sdk.Objects.Images.DmImageFolder Class Reference

Represents a single folder in the tree of folders used to store images in your dotMailer account. More...

Inheritance diagram for dotMailer.Sdk.Objects.Images.DmImageFolder:
dotMailer.Sdk.Interfaces.IDmObject dotMailer.Sdk.Cache.IDmCacheableObject

Public Member Functions

DmImageFolder CreateChildFolder (string folderName)
 Creates a new image folder as a child of this folder.
 
int IndexOfChildFolder (string folderName, bool caseSensitive=false)
 Searches for the specified child folder and returns the zero-based index of the first occurrence.
 

Properties

string UserTag1 [get, set]
 User Tag
 
string UserTag2 [get, set]
 User Tag
 
string UserTag3 [get, set]
 User Tag
 
string ObjectType [get, set]
 Returns the type name of the class Used by the serialisation process
 
bool IsDirty [get]
 Returns true if the object has changed
 
string ExternalId [get]
 The generated Id that uniquely identifies this record across all dotMailer accounts.
 
int AccountId [get, set]
 The dotMailer account Id for this document folder.
 
int Id [get, set]
 The unique ID of this folder within the dotMailer account.
 
string Name [get, set]
 The name of the folder.
 
DmImageFolderCollection ChildFolders [get, set]
 A collection of child folders to which this folder acts as a parent folder.
 
- Properties inherited from dotMailer.Sdk.Interfaces.IDmObject
int AccountId [get]
 The DotMailer account Id for this object
 
string ExternalId [get]
 A key that represents this object, used for synching with external applications
 
bool IsDirty [get]
 has the data of the object changed
 

Detailed Description

Represents a single folder in the tree of folders used to store images in your dotMailer account.

Member Function Documentation

DmImageFolder dotMailer.Sdk.Objects.Images.DmImageFolder.CreateChildFolder ( string  folderName)

Creates a new image folder as a child of this folder.

Parameters
folderName
int dotMailer.Sdk.Objects.Images.DmImageFolder.IndexOfChildFolder ( string  folderName,
bool  caseSensitive = false 
)

Searches for the specified child folder and returns the zero-based index of the first occurrence.

Parameters
folderNameThe name of the folder to find.
caseSensitivePass true if the search should be case sensitive.
Returns
The index of the child folder, or -1 if the folder was not found.

Property Documentation

int dotMailer.Sdk.Objects.Images.DmImageFolder.AccountId
getset

The dotMailer account Id for this document folder.

DmImageFolderCollection dotMailer.Sdk.Objects.Images.DmImageFolder.ChildFolders
getset

A collection of child folders to which this folder acts as a parent folder.

string dotMailer.Sdk.Objects.Images.DmImageFolder.ExternalId
get

The generated Id that uniquely identifies this record across all dotMailer accounts.

int dotMailer.Sdk.Objects.Images.DmImageFolder.Id
getset

The unique ID of this folder within the dotMailer account.

bool dotMailer.Sdk.Objects.Images.DmImageFolder.IsDirty
get

Returns true if the object has changed

string dotMailer.Sdk.Objects.Images.DmImageFolder.Name
getset

The name of the folder.

string dotMailer.Sdk.Objects.Images.DmImageFolder.ObjectType
getset

Returns the type name of the class Used by the serialisation process

string dotMailer.Sdk.Objects.Images.DmImageFolder.UserTag1
getset

User Tag

string dotMailer.Sdk.Objects.Images.DmImageFolder.UserTag2
getset

User Tag

string dotMailer.Sdk.Objects.Images.DmImageFolder.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3