iFolder::WebService::iFolderUser Class Reference

An iFolder User. More...

Inheritance diagram for iFolder::WebService::iFolderUser:

[legend]

Collaboration diagram for iFolder::WebService::iFolderUser:

[legend]

List of all members.

Public Types
enum	Encryption
	encryption options. More...
Public Member Functions
	iFolderUser ()
	Constructor.
Static Public Member Functions
static iFolderUser	SetUser (string userID, iFolderUser user, string accessID)
	Update a User.
static iFolderUser	GetUser (string userID, string accessID)
	Get a Member of an iFolder.
static iFolderUser	GetUser (string ifolderID, string userID, string accessID)
	Get a Member of an iFolder.
static iFolderUserSet	GetUsers (string ifolderID, int index, int max, string accessID)
	Get the Members of an iFolder.
static iFolderUserSet	GetUsers (SearchProperty property, SearchOperation operation, string pattern, int index, int max, string accessID)
	Get Users by Search.
static iFolderUserSet	GetReprovisionUsers (int index, int max, string accessID)
	Get Users by Search, gets only users that are getting moved.
static void	ProvisionUsersToServers (string[] ServerNames, string[] UserIDs)
	Provision Users to different servers given in the Hashtable.
static void	ProvisionUsersToServer (string ServerName, string[] UserIDs)
	Provision Users to one server.
static void	ReProvisionUsersToServer (string ServerName, string UserID)
	Provision Users to one server.
static void	SetMemberRights (string ifolderID, string userID, Rights rights, string accessID)
	Set the iFolder Rights of a Member.
static void	AddMember (string ifolderID, string userID, Rights rights, string accessID)
	Add a Member to an iFolder.
static void	RemoveMember (string ifolderID, string userID, string accessID)
	Remove a Member from an iFolder.
static string[]	GetGroupIDs (string userID)
	Get Group IDs of this member.
static void	SetOwner (string ifolderID, string userID, string accessID, bool OrphanAdopt)
	Se the Owner of an iFolder.
static bool	IsAdministrator (string userID)
	Is the User an Administrator.
static void	AddAdministrator (string userID)
	Give a User Administration Rights.
static void	RemoveAdministrator (string userID)
	Remove Administration Rights from a User.
static iFolderUserSet	GetAdministrators (int index, int max)
	Get the Administrators.
static bool	IsUserOrSystemEncryptionEnforced (string userID)
static bool	IsPassPhraseSet (string DomainID, string AccessID)
static Simias.Authentication.Status	ValidatePassPhrase (string DomainID, string Passphrase, string AccessID)
Public Attributes
string	ID
	The User ID.
string	UserName
	The User Name.
string	FullName
	The User Preferred Full Name.
string	FirstName
	The User First Name.
string	LastName
	The User Last Name.
Rights	MemberRights
	The User Rights in the iFolder/Domain.
bool	Enabled
	Is the User's Login Enabled.
bool	IsOwner
	Is the User the Owner in the iFolder/Domain.
string	Email
	The User Email Address.
string	HomeServer
	The User HomeServer Name.
string	NewHomeServer
	The User HomeServer Name.
int	DataMovePercentage
	Percentage Data Move details.
string	DataMoveStatus
	Percentage Data Move details.
Protected Member Functions
	iFolderUser (Member member, Collection collection, Domain domain)
	Get an iFolder User Information Object.
	iFolderUser (Member member, Collection collection, Domain domain, bool DataMoveProp)
	Get an iFolder User Information Object, gets called only during user move object construction.

---

Detailed Description

An iFolder User.

---

Member Enumeration Documentation

enum iFolder::WebService::iFolderUser::Encryption

encryption options.

---

Constructor & Destructor Documentation

iFolder::WebService::iFolderUser::iFolderUser

(

)

[inline]

Constructor.

iFolder::WebService::iFolderUser::iFolderUser	(	Member	member,
		Collection	collection,
		Domain	domain
	)			[inline, protected]

Get an iFolder User Information Object.

Parameters:

	member	The Member Object
	collection	The Collection Object
	domain	The Domain Object

Returns:

An iFolderUser Object

iFolder::WebService::iFolderUser::iFolderUser	(	Member	member,
		Collection	collection,
		Domain	domain,
		bool	DataMoveProp
	)			[inline, protected]

Get an iFolder User Information Object, gets called only during user move object construction.

Parameters:

	member	The Member Object
	collection	The Collection Object
	domain	The Domain Object
	DataMoveProp	Data move percentage calculation property

Returns:

An iFolderUser Object

---

Member Function Documentation

static iFolderUser iFolder::WebService::iFolderUser::SetUser	(	string	userID,
		iFolderUser	user,
		string	accessID
	)			[inline, static]

Update a User.

Parameters:

	userID	The User ID
	user	The iFolderUser object with updated fields.
	accessID	The Access User ID

Returns:

An updated iFolderUser Object

static iFolderUser iFolder::WebService::iFolderUser::GetUser	(	string	userID,
		string	accessID
	)			[inline, static]

Get a Member of an iFolder.

Parameters:

	userID	The User ID
	accessID	The Access User ID

Returns:

An iFolderUser Object

static iFolderUser iFolder::WebService::iFolderUser::GetUser	(	string	ifolderID,
		string	userID,
		string	accessID
	)			[inline, static]

Get a Member of an iFolder.

Parameters:

	ifolderID	The iFolder ID
	userID	The User ID
	accessID	The Access User ID

Returns:

An iFolderUser Object

static iFolderUserSet iFolder::WebService::iFolderUser::GetUsers	(	string	ifolderID,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get the Members of an iFolder.

Parameters:

	ifolderID	The iFolder ID
	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

An iFolder User Set

static iFolderUserSet iFolder::WebService::iFolderUser::GetUsers	(	SearchProperty	property,
		SearchOperation	operation,
		string	pattern,
		int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get Users by Search.

Parameters:

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

Returns:

An iFolder User Set

static iFolderUserSet iFolder::WebService::iFolderUser::GetReprovisionUsers	(	int	index,
		int	max,
		string	accessID
	)			[inline, static]

Get Users by Search, gets only users that are getting moved.

Parameters:

	index	The Search Start Index
	max	The Search Max Count of Results
	accessID	The Access User ID

Returns:

An iFolder User Set

static void iFolder::WebService::iFolderUser::ProvisionUsersToServers	(	string[]	ServerNames,
		string[]	UserIDs
	)			[inline, static]

Provision Users to different servers given in the Hashtable.

Parameters:

	ServerProvisioningNames	Hashtable containing userids and servernames
	ServerNames	A string array containing server names
	UserIDs	A string array containing corresponding userids

static void iFolder::WebService::iFolderUser::ProvisionUsersToServer	(	string	ServerName,
		string[]	UserIDs
	)			[inline, static]

Provision Users to one server.

Parameters:

	ServerName	A string containing server's name.
	ListOfUsers	An array of string containing userIDs

static void iFolder::WebService::iFolderUser::ReProvisionUsersToServer	(	string	ServerName,
		string	UserID
	)			[inline, static]

Provision Users to one server.

Parameters:

	ServerName	A string containing server's name.
	UserID	string containing userID

static void iFolder::WebService::iFolderUser::SetMemberRights	(	string	ifolderID,
		string	userID,
		Rights	rights,
		string	accessID
	)			[inline, static]

Set the iFolder Rights of a Member.

Parameters:

	ifolderID	The iFolder ID
	userID	The Member User ID
	rights	The New Rights
	accessID	The Access User ID

static void iFolder::WebService::iFolderUser::AddMember	(	string	ifolderID,
		string	userID,
		Rights	rights,
		string	accessID
	)			[inline, static]

Add a Member to an iFolder.

Parameters:

	ifolderID	The iFolder ID
	userID	The User ID
	rights	The New Rights
	accessID	The Access User ID

static void iFolder::WebService::iFolderUser::RemoveMember	(	string	ifolderID,
		string	userID,
		string	accessID
	)			[inline, static]

Remove a Member from an iFolder.

Parameters:

	ifolderID	The iFolder ID
	userID	The User ID
	accessID	The Access User ID

static string [] iFolder::WebService::iFolderUser::GetGroupIDs

(

string

userID

)

[inline, static]

Get Group IDs of this member.

Parameters:

	userID	The User ID
	accessID	The Access User ID

static void iFolder::WebService::iFolderUser::SetOwner	(	string	ifolderID,
		string	userID,
		string	accessID,
		bool	OrphanAdopt
	)			[inline, static]

Se the Owner of an iFolder.

Parameters:

	ifolderID	The iFolder ID
	userID	The User ID
	accessID	The Access User ID

static bool iFolder::WebService::iFolderUser::IsAdministrator

(

string

userID

)

[inline, static]

Is the User an Administrator.

A User is a system administrator if the user has "Admin" rights in the domain.

Parameters:

userID

The User ID

Returns:

true, if the User is a System Administrator

static void iFolder::WebService::iFolderUser::AddAdministrator

(

string

userID

)

[inline, static]

Give a User Administration Rights.

A User is a system administrator if the user has "Admin" rights in the domain.

Parameters:

userID

The User ID

static void iFolder::WebService::iFolderUser::RemoveAdministrator

(

string

userID

)

[inline, static]

Remove Administration Rights from a User.

Administration rights are removed by giving the user "ReadOnly" rights in the domain.

Parameters:

userID

The User ID

static iFolderUserSet iFolder::WebService::iFolderUser::GetAdministrators	(	int	index,
		int	max
	)			[inline, static]

Get the Administrators.

Parameters:

	index	The Search Start Index
	max	The Search Max Count of Results

A User is a system administrator if the user has "Admin" rights in the domain.

Returns:

An iFolder User Set

summary> checks whether encryption is enforced for this user or not, if no user level policy exists , then check for system level enforcement /summary> returns>true/false

static bool iFolder::WebService::iFolderUser::IsUserOrSystemEncryptionEnforced

(

string

userID

)

[inline, static]

summary>

static bool iFolder::WebService::iFolderUser::IsPassPhraseSet	(	string	DomainID,
		string	AccessID
	)			[inline, static]

Checks whether passphrase is set for this member or not returns>true if passphrase was set earlier

summary> Validate the passphrase for the correctness /summary> returns>status

static Simias.Authentication.Status iFolder::WebService::iFolderUser::ValidatePassPhrase	(	string	DomainID,
		string	Passphrase,
		string	AccessID
	)			[inline, static]

summary> Set the passphrase and recovery agent /summary> returns>None

---

Member Data Documentation

string iFolder::WebService::iFolderUser::ID

The User ID.

string iFolder::WebService::iFolderUser::UserName

The User Name.

string iFolder::WebService::iFolderUser::FullName

The User Preferred Full Name.

string iFolder::WebService::iFolderUser::FirstName

The User First Name.

string iFolder::WebService::iFolderUser::LastName

The User Last Name.

Rights iFolder::WebService::iFolderUser::MemberRights

The User Rights in the iFolder/Domain.

bool iFolder::WebService::iFolderUser::Enabled

Is the User's Login Enabled.

bool iFolder::WebService::iFolderUser::IsOwner

Is the User the Owner in the iFolder/Domain.

string iFolder::WebService::iFolderUser::Email

The User Email Address.

string iFolder::WebService::iFolderUser::HomeServer

The User HomeServer Name.

string iFolder::WebService::iFolderUser::NewHomeServer

The User HomeServer Name.

int iFolder::WebService::iFolderUser::DataMovePercentage

Percentage Data Move details.

string iFolder::WebService::iFolderUser::DataMoveStatus

Percentage Data Move details.

---

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

• src/webservices/iFolderUser.cs