iFolder::WebService::iFolder Class Reference

An iFolder. More...

Inheritance diagram for iFolder::WebService::iFolder:

[legend]

Collaboration diagram for iFolder::WebService::iFolder:

[legend]

List of all members.

Public Member Functions
	iFolder ()
	Constructor.
Static Public Member Functions
static iFolder	CreateiFolder (string name, string userID, string description)
	Create an iFolder through web admin.
static iFolder	CreateiFolder (string name, string userID, string description, string accessID, bool ssl, string encryptionAlgorithm, string PassPhrase)
	Create an iFolder through web access.
static string	GetiFolderLocation (string ifolderID)
	Get the private url of iFolder's HomeServer.
static string[]	GetRAList ()
	Get the recovery agent list.
static bool	ShowTabDetails (string PassPhrase, string EncryptionAlgorithm)
	check if the tabs should be shown for the encrypted ifolder
static byte[]	GetRACertificate (string rAgent)
	Get the Certificate for the specified store.
static iFolder	GetiFolder (string ifolderID, string accessID)
	Get an iFolder.
static iFolder	GetiFolderByName (string ifolderName, string accessID)
	Get an iFolder by Name.
static Rights	Impersonate (Collection collection, string accessID)
	Impersonate the User on the Collection.
static void	DeleteiFolder (string ifolderID, string accessID)
	Delete an iFolder.
static iFolderSet	GetiFoldersByMember (string userID, MemberRole role, int index, int max, string accessID)
	Get iFolders by Member.
static iFolderSet	GetiFoldersByMember (string userID, MemberRole role, SearchOperation operation, string pattern, int index, int max, string accessID)
	Get iFolders by Member.
static iFolderSet	GetiFoldersByMember (string userID, MemberRole role, DateTime after, SearchOperation operation, string pattern, int index, int max, string accessID)
	Get iFolders by Member.
static iFolderSet	GetiFoldersByName (iFolderType type, SearchOperation operation, string pattern, int index, int max, string accessID)
	Get iFolders by Name.
static iFolderSet	GetOrphanediFolders (SearchOperation operation, string pattern, int index, int max, string accessID)
	Get Orphaned iFolders.
static string	IsOrphanediFolder (string iFolderID, string AccessID)
	check the orphaned property of an ifolder
static void	SetDescription (string ifolderID, string description, string accessID)
	Se the Description of an iFolder.
static void	PublishiFolder (string ifolderID, bool publish, string accessID)
	Publish an iFolder.
static void	SetMigratedFlag (string iFolderID, int MigrationSource)
	Set the migrated flag for the iFolder to determine that the iFolder is a migrated one.
Public Attributes
string	ID
	The iFolder ID.
string	Name
	The iFolder Name.
string	Description
	The iFolder Description.
string	OwnerID
	The iFolder OwnerID.
string	OwnerUserName
	The iFolder Owner User Name.
string	OwnerFullName
	The iFolder Owner Full Name.
string	DomainID
	The iFolder Domain ID.
long	Size = 0
	The iFolder Size.
bool	IsOwner
	Owner?
Rights	MemberRights
	iFolder/Domain Access Rights
DateTime	Created = DateTime.MinValue
	iFolder Created Time
DateTime	LastModified = DateTime.MinValue
	iFolder Last Modified Time
bool	Published = false
	Has the iFolder been marked Published?
bool	Enabled = true
	iFolder Enabled?
int	MemberCount = 0
	Number of Members.
string	HostID
	HostID of the location of the collection.
uint	IfolderSecurity = 0
	bitmap has encryption and SSL state for the ifolder
string	EncryptionAlgorithm = ""
	If encryption enabled, the algorithm type.
string	EncryptionKey = ""
	If encryption enabled, the encryptionkey.
int	FolderMoveStatus = 0
	If encryption enabled, the encryptionkey.
Protected Member Functions
	iFolder (Collection c, string accessID)
	Constructor.
	iFolder (CatalogEntry ce, string accessID)
	Constructor.

---

Detailed Description

An iFolder.

---

Constructor & Destructor Documentation

iFolder::WebService::iFolder::iFolder

(

)

[inline]

Constructor.

iFolder::WebService::iFolder::iFolder	(	Collection	c,
		string	accessID
	)			[inline, protected]

Constructor.

Parameters:

	c	The iFolder Collection
	accessID	The Access User ID

iFolder::WebService::iFolder::iFolder	(	CatalogEntry	ce,
		string	accessID
	)			[inline, protected]

Constructor.

Parameters:

	ce	The Catalog Entry
	accessID	The Access User ID

---

Member Function Documentation

static iFolder iFolder::WebService::iFolder::CreateiFolder	(	string	name,
		string	userID,
		string	description
	)			[inline, static]

Create an iFolder through web admin.

Parameters:

	name	The iFolder Name
	userID	The User ID of the iFolder Owner
	description	The iFolder Description
	accessID	The Access ID

Returns:

An iFolder Object

static iFolder iFolder::WebService::iFolder::CreateiFolder	(	string	name,
		string	userID,
		string	description,
		string	accessID,
		bool	ssl,
		string	encryptionAlgorithm,
		string	PassPhrase
	)			[inline, static]

Create an iFolder through web access.

Parameters:

	name	The iFolder Name
	userID	The User ID of the iFolder Owner
	description	The iFolder Description
	accessID	The Access ID

Returns:

An iFolder Object

static string iFolder::WebService::iFolder::GetiFolderLocation

(

string

ifolderID

)

[inline, static]

Get the private url of iFolder's HomeServer.

Parameters:

name

The iFolder ID

Returns:

Private url of iFolder's HomeServer

static string [] iFolder::WebService::iFolder::GetRAList

(

)

[inline, static]

Get the recovery agent list.

Returns:

The list as a string array

static bool iFolder::WebService::iFolder::ShowTabDetails	(	string	PassPhrase,
		string	EncryptionAlgorithm
	)			[inline, static]

check if the tabs should be shown for the encrypted ifolder

Returns:

boolean value

static byte [] iFolder::WebService::iFolder::GetRACertificate

(

string

rAgent

)

[inline, static]

Get the Certificate for the specified store.

Parameters:

host

The host who owns the certificate.

Returns:

The certificate as a byte array.

static iFolder iFolder::WebService::iFolder::GetiFolder	(	string	ifolderID,
		string	accessID
	)			[inline, static]

Get an iFolder.

Parameters:

	ifolderID	The iFolder ID
	accessID	The Access User ID

Returns:

An iFolder Object

static iFolder iFolder::WebService::iFolder::GetiFolderByName	(	string	ifolderName,
		string	accessID
	)			[inline, static]

Get an iFolder by Name.

Parameters:

	ifolderName	The iFolder Name
	accessID	The Access User ID

Returns:

An iFolder Object

static Rights iFolder::WebService::iFolder::Impersonate	(	Collection	collection,
		string	accessID
	)			[inline, static]

Impersonate the User on the Collection.

Parameters:

	collection	The iFolder Collection
	accessID	The Access User ID

Returns:

Member Rights

static void iFolder::WebService::iFolder::DeleteiFolder	(	string	ifolderID,
		string	accessID
	)			[inline, static]

Delete an iFolder.

Parameters:

	ifolderID	The iFolder ID
	accessID	The Access User ID

static iFolderSet iFolder::WebService::iFolder::GetiFoldersByMember	(	string	userID,
		MemberRole	role,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get iFolders by Member.

Parameters:

	userID	The User ID
	role	The Member Role
	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

A Set of iFolder Objects

static iFolderSet iFolder::WebService::iFolder::GetiFoldersByMember	(	string	userID,
		MemberRole	role,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get iFolders by Member.

Parameters:

	userID	The User ID
	role	The Member Role
	operation	The Search Operation
	pattern	The Search Pattern
	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

A Set of iFolder Objects

static iFolderSet iFolder::WebService::iFolder::GetiFoldersByMember	(	string	userID,
		MemberRole	role,
		DateTime	after,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get iFolders by Member.

Parameters:

	userID	The User ID
	role	The Member Role
	after	Shared After Date/Time
	operation	The Search Operation
	pattern	The Search Pattern
	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

A Set of iFolder Objects

static iFolderSet iFolder::WebService::iFolder::GetiFoldersByName	(	iFolderType	type,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get iFolders by Name.

Parameters:

	type	iFolder Type
	operation	The Search Operation
	pattern	The Search Pattern
	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

A Set of iFolder Objects

static iFolderSet iFolder::WebService::iFolder::GetOrphanediFolders	(	SearchOperation	operation,
		string	pattern,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get Orphaned iFolders.

Parameters:

	operation	The Search Operation
	pattern	The Search Pattern
	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

A Set of iFolder Objects

static string iFolder::WebService::iFolder::IsOrphanediFolder	(	string	iFolderID,
		string	AccessID
	)			[inline, static]

check the orphaned property of an ifolder

Parameters:

	ifolderID	The iFolder ID
	accessID	The Access User ID

Returns:

a string 'false' if the ifolder is not orphaned otherwise returns userID of prev owner

static void iFolder::WebService::iFolder::SetDescription	(	string	ifolderID,
		string	description,
		string	accessID
	)			[inline, static]

Se the Description of an iFolder.

Parameters:

	ifolderID	The iFolder ID
	description	The New iFolder Description
	accessID	The Access User ID

static void iFolder::WebService::iFolder::PublishiFolder	(	string	ifolderID,
		bool	publish,
		string	accessID
	)			[inline, static]

Publish an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	publish	The new published state.
	accessID	The access id.

Only the owner of the iFolder can publish it.

static void iFolder::WebService::iFolder::SetMigratedFlag	(	string	iFolderID,
		int	MigrationSource
	)			[inline, static]

Set the migrated flag for the iFolder to determine that the iFolder is a migrated one.

Parameters:

	ifolderID	The id of the iFolder.
	MigrationSource	Determines from which source the iFolder is migrated. (whether from iFolder2 server or 3.2 server or anyother

Returns:

---

Member Data Documentation

string iFolder::WebService::iFolder::ID

The iFolder ID.

string iFolder::WebService::iFolder::Name

The iFolder Name.

string iFolder::WebService::iFolder::Description

The iFolder Description.

string iFolder::WebService::iFolder::OwnerID

The iFolder OwnerID.

string iFolder::WebService::iFolder::OwnerUserName

The iFolder Owner User Name.

string iFolder::WebService::iFolder::OwnerFullName

The iFolder Owner Full Name.

string iFolder::WebService::iFolder::DomainID

The iFolder Domain ID.

long iFolder::WebService::iFolder::Size = 0

The iFolder Size.

bool iFolder::WebService::iFolder::IsOwner

Owner?

Rights iFolder::WebService::iFolder::MemberRights

iFolder/Domain Access Rights

DateTime iFolder::WebService::iFolder::Created = DateTime.MinValue

iFolder Created Time

DateTime iFolder::WebService::iFolder::LastModified = DateTime.MinValue

iFolder Last Modified Time

bool iFolder::WebService::iFolder::Published = false

Has the iFolder been marked Published?

bool iFolder::WebService::iFolder::Enabled = true

iFolder Enabled?

int iFolder::WebService::iFolder::MemberCount = 0

Number of Members.

string iFolder::WebService::iFolder::HostID

HostID of the location of the collection.

uint iFolder::WebService::iFolder::IfolderSecurity = 0

bitmap has encryption and SSL state for the ifolder

string iFolder::WebService::iFolder::EncryptionAlgorithm = ""

If encryption enabled, the algorithm type.

string iFolder::WebService::iFolder::EncryptionKey = ""

If encryption enabled, the encryptionkey.

int iFolder::WebService::iFolder::FolderMoveStatus = 0

If encryption enabled, the encryptionkey.

---

The documentation for this class was generated from the following file:

• src/webservices/iFolder.cs