iFolder::WebService::iFolderWeb Class Reference

iFolder Web Service More...

Inheritance diagram for iFolder::WebService::iFolderWeb:

[legend]

Collaboration diagram for iFolder::WebService::iFolderWeb:

[legend]

List of all members.

Public Member Functions
	iFolderWeb ()
	Constructor.
override iFolderSystem	GetSystem ()
	Get information about the iFolder system.
override iFolderServer	GetHomeServer ()
	Get information about the authenticated user's home iFolder server.
override void	SetMigratedFlag (string iFolderID, int MigrationSource)
	Set the migrated flag for the iFolder to determine that the iFolder is a migrated one.
override iFolderServer[]	GetServers ()
	Get information about all the iFolder servers.
override iFolderServerSet	GetServersByName (SearchOperation operation, string pattern, int index, int count)
	Get information about iFolder Servers identified by a search on name.
override void	DeleteiFolder (string ifolderID)
	Delete an iFolder.
override iFolder	GetiFolder (string ifolderID)
	Get information about an iFolder.
override string	GetiFolderLocation (string ifolderID)
	Get the HomeServer for the specified user.
override string[]	GetRAList ()
	Get the recovery agent list.
override byte[]	GetRACertificate (string rAgent)
	Get the recovery Agent certificate.
override bool	IsPassPhraseSet ()
	Get the PassPhrase status.
override bool	IsUserOrSystemEncryptionEnforced (string UserID)
	returns whether encryption is enforced for this user or not. checks the whole priority structure
override bool	ShowTabDetails (string PassPhrase, string EncryptionAlgorithm)
	Checks whether an encrypted ifolders should be shown.
override Simias.Authentication.Status	ValidatePassPhrase (string passPhrase)
override void	SetPassPhrase (string passPhrase, string recoveryAgentName, string publicKey)
override iFolderDetails	GetiFolderDetails (string ifolderID)
	Get detailed information about an iFolder.
override void	SetiFolderDescription (string ifolderID, string description)
	Set the description of an iFolder.
override void	PublishiFolder (string ifolderID, bool publish)
	Publish an iFolder.
override ChangeEntrySet	GetChanges (string ifolderID, string itemID, int index, int max)
	Get a history of changes to an iFolder.
override string	TrimUrl (string FullUrl)
	Get a trimmed url from full url.
override iFolderUser	GetAuthenticatedUser ()
	Get information about the authenticated user.
override void	SetMemberRights (string ifolderID, string userID, Rights rights)
	Set the rights of a member on an iFolder.
override void	AddMember (string ifolderID, string userID, Rights rights)
	Add a member to an iFolder.
override void	RemoveMember (string ifolderID, string userID)
	Remove a member from an iFolder.
override string[]	GetGroupIDs (string userID)
	Gets the group ids this member belongs to .
override void	SetiFolderOwner (string ifolderID, string userID, bool OrphanAdopt)
	Set the owner of an iFolder.
override iFolderUserSet	GetMembers (string ifolderID, int index, int max)
	Get information about the members of an iFolder.
override iFolderUserSet	GetUsers (int index, int max)
	Get information about all of the iFolder users.
override iFolderUser	GetUser (string userID)
	Get information about a user using an id or username.
override iFolderUserDetails	GetUserDetails (string userID)
	Get detailed information about a user.
override iFolderUserSet	GetUsersBySearch (SearchProperty property, SearchOperation operation, string pattern, int index, int max)
	Get information about all of the iFolder users identified by the search property, operation, and pattern.
override string	GetShortenedName (string name, int length)
	Shorten the name so that it can fit inot dispaly .
override iFolder	CreateiFolder (string name, string description, bool ssl, string EncryptionAlgorithm, string PassPhrase)
	Create a new iFolder with the authenticated user as the owner.
override iFolderSet	GetiFolders (int index, int max)
	Get information about all the iFolders to which the authenticate user has rights.
override iFolderSet	GetiFoldersByName (SearchOperation operation, string pattern, int index, int max)
	Get information about iFolders identified by the search operation and pattern.
override int	GetiFolderLimitPolicyStatus (string userID)
	Get the ifolder limit policy for a User.
override iFolderSet	GetiFoldersBySearch (MemberRole role, DateTime after, SearchOperation operation, string pattern, int index, int max)
	Get information about iFolder identified by role, creation time, and search operation and pattern.
override void	RemoveMembership (string ifolderID)
	Remove the authenticated user's membership to an iFolder.
override UserPolicy	GetAuthenticatedUserPolicy ()
	Get policy information for the authenticated user.
override iFolderPolicy	GetiFolderPolicy (string ifolderID)
	Get policy information for an iFolder.
override int	GetEncryptionPolicy ()
	Gets the encryption policy for an iFolder.
override void	SetiFolderPolicy (iFolderPolicy policy)
	Set the policy for an iFolder.
override iFolderEntry	CreateEntry (string ifolderID, string parentID, iFolderEntryType type, string entryName)
	Create an iFolder entry (file or directory).
override int	CreateNodes (string ifolderID, bool RemoveEntry)
	Create nodes.
override void	DeleteEntry (string ifolderID, string entryID)
	Delete an iFolder entry.
override iFolderEntry	GetEntry (string ifolderID, string entryID)
	Get information about an iFolder entry.
override iFolderEntry	GetEntryByPath (string ifolderID, string entryPath)
	Get information about an entry identified by it's relative path in the iFolder.
override iFolderEntrySet	GetEntries (string ifolderID, string entryID, int index, int max)
	Get information about entries in an iFolder identified by their parent entry.
override iFolderEntrySet	GetEntriesByName (string ifolderID, string parentID, SearchOperation operation, string pattern, int index, int max)
	Get information about entries in an iFolder identified by a search on the name.
override iFolderEntrySet	GetMatchedEntries (string ifolderID, string entryID, string[] folder)
	Get information about entries identified by their parent entry. Search it with the passed folder array and return those matched.
override string	GetSetting (string name)
	Get a setting specific to the authenticated user.
override void	SetSetting (string name, string value)
	Set a setting specific to the authenticated user.
override string	OpenFileRead (string ifolderID, string entryID)
	Open an iFolder file entry for reading.
override string	OpenFileWrite (string ifolderID, string entryID, long length)
	Open an iFolder file entry for writing.
override byte[]	ReadFile (string file, int size)
	Read from an openned iFolder file entry.
override void	WriteFile (string file, byte[] buffer)
	Write to an openned iFolder file entry.
override void	CloseFile (string file)
	Close an openned iFolder file entry.
override void	SetFileLength (string ifolderID, string nodeID, long length)
	Set the file length.

---

Detailed Description

iFolder Web Service

---

Constructor & Destructor Documentation

iFolder::WebService::iFolderWeb::iFolderWeb

(

)

[inline]

Constructor.

---

Member Function Documentation

override iFolderSystem iFolder::WebService::iFolderWeb::GetSystem

(

)

[inline, virtual]

Get information about the iFolder system.

Returns:

An iFolderSystem object describing the system.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderServer iFolder::WebService::iFolderWeb::GetHomeServer

(

)

[inline, virtual]

Get information about the authenticated user's home iFolder server.

Returns:

An iFolderServer object describing the user's home iFolder server.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::SetMigratedFlag	(	string	iFolderID,
		int	MigrationSource
	)			[inline, virtual]

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. (whther from iFolder2 server or 3.2 server or anyother

///

Returns:

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderServer [] iFolder::WebService::iFolderWeb::GetServers

(

)

[inline, virtual]

Get information about all the iFolder servers.

Returns:

An array of iFolderServer objects.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderServerSet iFolder::WebService::iFolderWeb::GetServersByName	(	SearchOperation	operation,
		string	pattern,
		int	index,
		int	count
	)			[inline, virtual]

Get information about iFolder Servers identified by a search on name.

Parameters:

	operation	The operation to compare the name and pattern.
	pattern	The pattern to search.
	index	The starting index for the search results.
	count	The max number of search results to be returned.

Returns:

A set of iFolder Server objects.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::DeleteiFolder

(

string

ifolderID

)

[inline, virtual]

Delete an iFolder.

Parameters:

ifolderID

The id of the iFolder to be deleted.

This API will accept multiple iFolder ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolder iFolder::WebService::iFolderWeb::GetiFolder

(

string

ifolderID

)

[inline, virtual]

Get information about an iFolder.

Parameters:

ifolderID

The id of the iFolder.

Returns:

An iFolder object describing the iFolder.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderWeb::GetiFolderLocation

(

string

ifolderID

)

[inline, virtual]

Get the HomeServer for the specified user.

Returns:

HomeServer ID

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string [] iFolder::WebService::iFolderWeb::GetRAList

(

)

[inline, virtual]

Get the recovery agent list.

Returns:

list as a string array

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override byte [] iFolder::WebService::iFolderWeb::GetRACertificate

(

string

rAgent

)

[inline, virtual]

Get the recovery Agent certificate.

Returns:

byte array containing the certificate

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override bool iFolder::WebService::iFolderWeb::IsPassPhraseSet

(

)

[inline, virtual]

Get the PassPhrase status.

Returns:

the bool value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override bool iFolder::WebService::iFolderWeb::IsUserOrSystemEncryptionEnforced

(

string

UserID

)

[inline, virtual]

returns whether encryption is enforced for this user or not. checks the whole priority structure

Returns:

the bool value

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override bool iFolder::WebService::iFolderWeb::ShowTabDetails	(	string	PassPhrase,
		string	EncryptionAlgorithm
	)			[inline, virtual]

Checks whether an encrypted ifolders should be shown.

Returns:

the bool value

summary> Validate the passphrase for the correctness /summary> returns>passPhrase.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override Simias.Authentication.Status iFolder::WebService::iFolderWeb::ValidatePassPhrase

(

string

passPhrase

)

[inline, virtual]

summary> Set the passphrase and recovery agent /summary> returns>passPhrase.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::SetPassPhrase	(	string	passPhrase,
		string	recoveryAgentName,
		string	publicKey
	)			[inline, virtual]

summary> checks if for this user, encryption is enforced /summary> returns>true/false

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderDetails iFolder::WebService::iFolderWeb::GetiFolderDetails

(

string

ifolderID

)

[inline, virtual]

Get detailed information about an iFolder.

Parameters:

ifolderID

The id of the iFolder

Returns:

An iFolderDetails object describing the iFolder

It is more expensive to call GetiFolderDetails than GetiFolder.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::SetiFolderDescription	(	string	ifolderID,
		string	description
	)			[inline, virtual]

Set the description of an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	description	The new description for the iFolder.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::PublishiFolder	(	string	ifolderID,
		bool	publish
	)			[inline, virtual]

Publish an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	publish	The published state of the iFolder

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override ChangeEntrySet iFolder::WebService::iFolderWeb::GetChanges	(	string	ifolderID,
		string	itemID,
		int	index,
		int	max
	)			[inline, virtual]

Get a history of changes to an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	itemID	The id of item to filter the results (can be null for no filtering).
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of ChangeEntry objects.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderWeb::TrimUrl

(

string

FullUrl

)

[inline, virtual]

Get a trimmed url from full url.

Parameters:

FullUrl

Full URL to be called

Returns:

a trimmed url that will contain only aspx page name

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUser iFolder::WebService::iFolderWeb::GetAuthenticatedUser

(

)

[inline, virtual]

Get information about the authenticated user.

Returns:

An iFolderUser object describing the authenticated user.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::SetMemberRights	(	string	ifolderID,
		string	userID,
		Rights	rights
	)			[inline, virtual]

Set the rights of a member on an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	userID	The user id of the member.
	rights	The rights to be set.

This API will accept multiple user ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::AddMember	(	string	ifolderID,
		string	userID,
		Rights	rights
	)			[inline, virtual]

Add a member to an iFolder.

Parameters:

	ifolderID	The id of iFolder.
	userID	The user id of the new member.
	rights	The rights of the new member on the iFolder.

This API will accept multiple user ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::RemoveMember	(	string	ifolderID,
		string	userID
	)			[inline, virtual]

Remove a member from an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	userID	The user id of the member.

This API will accept multiple user ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string [] iFolder::WebService::iFolderWeb::GetGroupIDs

(

string

userID

)

[inline, virtual]

Gets the group ids this member belongs to .

Parameters:

userID

The user id of the member.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override void iFolder::WebService::iFolderWeb::SetiFolderOwner	(	string	ifolderID,
		string	userID,
		bool	OrphanAdopt
	)			[inline, virtual]

Set the owner of an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	userID	The user id of the new owner.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUserSet iFolder::WebService::iFolderWeb::GetMembers	(	string	ifolderID,
		int	index,
		int	max
	)			[inline, virtual]

Get information about the members of an iFolder.

Parameters:

	ifolderID	The id of the iFolder.
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects describing the members.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUserSet iFolder::WebService::iFolderWeb::GetUsers	(	int	index,
		int	max
	)			[inline, virtual]

Get information about all of the iFolder users.

Parameters:

	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUser iFolder::WebService::iFolderWeb::GetUser

(

string

userID

)

[inline, virtual]

Get information about a user using an id or username.

Parameters:

userID

The id or username of the user.

Returns:

A iFolderUser object.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUserDetails iFolder::WebService::iFolderWeb::GetUserDetails

(

string

userID

)

[inline, virtual]

Get detailed information about a user.

Parameters:

userID

The id of the user.

Returns:

A iFolderUserDetails object.

It is more expensive to call GetUserDetails than GetUser.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolderUserSet iFolder::WebService::iFolderWeb::GetUsersBySearch	(	SearchProperty	property,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			[inline, virtual]

Get information about all of the iFolder users identified by the search property, operation, and pattern.

Parameters:

	property	The property to search.
	operation	The operation to compare the property and pattern.
	pattern	The pattern to search
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderUser objects.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override string iFolder::WebService::iFolderWeb::GetShortenedName	(	string	name,
		int	length
	)			[inline, virtual]

Shorten the name so that it can fit inot dispaly .

Parameters:

name

The name of the iFolder to be shortened.

Returns:

< string which is short.

Reimplemented from iFolder::WebService::iFolderCommonLocal.

override iFolder iFolder::WebService::iFolderWeb::CreateiFolder	(	string	name,
		string	description,
		bool	ssl,
		string	EncryptionAlgorithm,
		string	PassPhrase
	)			[inline, virtual]

Create a new iFolder with the authenticated user as the owner.

Parameters:

	name	The name of the new iFolder.
	description	The description of the new iFolder.

Returns:

An iFolder object describing the new iFolder.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderSet iFolder::WebService::iFolderWeb::GetiFolders	(	int	index,
		int	max
	)			[inline, virtual]

Get information about all the iFolders to which the authenticate user has rights.

Parameters:

	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolder objects.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderSet iFolder::WebService::iFolderWeb::GetiFoldersByName	(	SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			[inline, virtual]

Get information about iFolders identified by the search operation and pattern.

Parameters:

	operation	The operation for the search.
	pattern	The pattern for the search.
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolder objects.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override int iFolder::WebService::iFolderWeb::GetiFolderLimitPolicyStatus

(

string

userID

)

[inline, virtual]

Get the ifolder limit policy for a User.

Parameters:

userID

The user id of the user who owns the ifolder.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderSet iFolder::WebService::iFolderWeb::GetiFoldersBySearch	(	MemberRole	role,
		DateTime	after,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			[inline, virtual]

Get information about iFolder identified by role, creation time, and search operation and pattern.

Parameters:

	role	The required authenticated user's role in the Folder.
	after	The required earliest limit on the shared date of the iFolder.
	operation	The operation for the search.
	pattern	The pattern for the search.
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolder objects.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::RemoveMembership

(

string

ifolderID

)

[inline, virtual]

Remove the authenticated user's membership to an iFolder.

Parameters:

ifolderID

The id of the iFolder.

This API will accept multiple iFolder ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override UserPolicy iFolder::WebService::iFolderWeb::GetAuthenticatedUserPolicy

(

)

[inline, virtual]

Get policy information for the authenticated user.

Returns:

A UserPolicy object describing the authenticated user's policy.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderPolicy iFolder::WebService::iFolderWeb::GetiFolderPolicy

(

string

ifolderID

)

[inline, virtual]

Get policy information for an iFolder.

Parameters:

ifolderID

The id of an iFolder.

Returns:

A iFolderPolicy object.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override int iFolder::WebService::iFolderWeb::GetEncryptionPolicy

(

)

[inline, virtual]

Gets the encryption policy for an iFolder.

Returns:

the policy as integer

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::SetiFolderPolicy

(

iFolderPolicy

policy

)

[inline, virtual]

Set the policy for an iFolder.

Parameters:

policy

The iFolderPolicy object.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderEntry iFolder::WebService::iFolderWeb::CreateEntry	(	string	ifolderID,
		string	parentID,
		iFolderEntryType	type,
		string	entryName
	)			[inline, virtual]

Create an iFolder entry (file or directory).

Parameters:

	ifolderID	The id of the iFolder.
	parentID	The id of the parent or containing entry.
	type	The type (file or directory for the entry.
	entryName	The name of the new entry.

Returns:

An iFolderEntry object describing the new entry.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override int iFolder::WebService::iFolderWeb::CreateNodes	(	string	ifolderID,
		bool	RemoveEntry
	)			[inline, virtual]

Create nodes.

Parameters:

ifolderID

The id of the iFolder.

Returns:

A boolean describing the new entry.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::DeleteEntry	(	string	ifolderID,
		string	entryID
	)			[inline, virtual]

Delete an iFolder entry.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the entry to be deleted.

This API will accept multiple entry ids in a comma delimited list.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderEntry iFolder::WebService::iFolderWeb::GetEntry	(	string	ifolderID,
		string	entryID
	)			[inline, virtual]

Get information about an iFolder entry.

Parameters:

	ifolderID	The id of the iFolder containing the entry.
	entryID	The id of the entry.

Returns:

An iFolderEntry object.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderEntry iFolder::WebService::iFolderWeb::GetEntryByPath	(	string	ifolderID,
		string	entryPath
	)			[inline, virtual]

Get information about an entry identified by it's relative path in the iFolder.

Parameters:

	ifolderID	The id of the iFolder containing the entry.
	entryPath	The relative path of entry.

Returns:

An iFolderEntry object.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderEntrySet iFolder::WebService::iFolderWeb::GetEntries	(	string	ifolderID,
		string	entryID,
		int	index,
		int	max
	)			[inline, virtual]

Get information about entries in an iFolder identified by their parent entry.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the parent entry (can be null for the root of the iFolder).
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderEntry objects.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderEntrySet iFolder::WebService::iFolderWeb::GetEntriesByName	(	string	ifolderID,
		string	parentID,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max
	)			[inline, virtual]

Get information about entries in an iFolder identified by a search on the name.

Parameters:

	ifolderID	The id of iFolder.
	parentID	The id of the parent entry.
	operation	The operation to compare the name and search pattern.
	pattern	The pattern to search.
	index	The starting index for the search results.
	max	The max number of search results to be returned.

Returns:

A set of iFolderEntry objects.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override iFolderEntrySet iFolder::WebService::iFolderWeb::GetMatchedEntries	(	string	ifolderID,
		string	entryID,
		string[]	folder
	)			[inline, virtual]

Get information about entries identified by their parent entry. Search it with the passed folder array and return those matched.

Parameters:

	ifolderID	ifolder id
	entryID	entry id
	folder	folder array where it will be searched

Returns:

iFolderEntry set which has matched

Reimplemented from iFolder::WebService::iFolderWebLocal.

override string iFolder::WebService::iFolderWeb::GetSetting

(

string

name

)

[inline, virtual]

Get a setting specific to the authenticated user.

Parameters:

name

The name of the setting.

Returns:

The value of the setting.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::SetSetting	(	string	name,
		string	value
	)			[inline, virtual]

Set a setting specific to the authenticated user.

Parameters:

	name	The name of the setting.
	value	The value of the setting.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override string iFolder::WebService::iFolderWeb::OpenFileRead	(	string	ifolderID,
		string	entryID
	)			[inline, virtual]

Open an iFolder file entry for reading.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the file entry.

Returns:

A file handle.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override string iFolder::WebService::iFolderWeb::OpenFileWrite	(	string	ifolderID,
		string	entryID,
		long	length
	)			[inline, virtual]

Open an iFolder file entry for writing.

Parameters:

	ifolderID	The id of the iFolder.
	entryID	The id of the file entry.
	length	The length of the file to be written.

Returns:

A file handle.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override byte [] iFolder::WebService::iFolderWeb::ReadFile	(	string	file,
		int	size
	)			[inline, virtual]

Read from an openned iFolder file entry.

Parameters:

	file	The file handle.
	size	The max size of the return buffer.

Returns:

An array of bytes.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::WriteFile	(	string	file,
		byte[]	buffer
	)			[inline, virtual]

Write to an openned iFolder file entry.

Parameters:

	file	The file handle.
	buffer	The buffer to be written.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::CloseFile

(

string

file

)

[inline, virtual]

Close an openned iFolder file entry.

Parameters:

file

The file handle.

Reimplemented from iFolder::WebService::iFolderWebLocal.

override void iFolder::WebService::iFolderWeb::SetFileLength	(	string	ifolderID,
		string	nodeID,
		long	length
	)			[inline, virtual]

Set the file length.

Parameters:

file

The file handle.

Reimplemented from iFolder::WebService::iFolderWebLocal.

---

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

• src/webservices/iFolderWeb.asmx.cs