OpenSim::Data::SQLite::SQLiteUserData Class Reference

A User storage interface for the SQLite database system. More...

Inheritance diagram for OpenSim::Data::SQLite::SQLiteUserData:

List of all members.

Public Member Functions
override void	Initialise ()
	Default-initialises the plugin.
override void	Initialise (string connect)
	Initialises User Interface Loads and initialises a new SQLite connection and maintains it. use default URI if connect string string is empty.
override void	Dispose ()
override UserProfileData	GetUserByUUID (UUID uuid)
	see IUserDataPlugin, Get user data profile by UUID
override UserProfileData	GetUserByName (string fname, string lname)
	see IUserDataPlugin, Get user data profile by name
override void	AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
	Add a new friend in the friendlist.
override void	RemoveUserFriend (UUID friendlistowner, UUID friend)
	Remove a user from the friendlist.
override void	UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
	Update the friendlist permission.
override List< FriendListItem >	GetUserFriendList (UUID friendlistowner)
	Get (fetch?) the friendlist for a user.
override Dictionary< UUID, FriendRegionInfo >	GetFriendRegionInfos (List< UUID > uuids)
	Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.
override List< AvatarPickerAvatar >	GeneratePickerResults (UUID queryID, string query)
override UserAgentData	GetAgentByUUID (UUID uuid)
	Returns a user by UUID direct.
override UserAgentData	GetAgentByName (string name)
	Returns a session by account name.
override UserAgentData	GetAgentByName (string fname, string lname)
	Returns a session by account name.
override void	StoreWebLoginKey (UUID AgentID, UUID WebLoginKey)
	DEPRECATED? Store the weblogin key.
override void	AddNewUserProfile (UserProfileData user)
	Creates a new user profile.
override bool	UpdateUserProfile (UserProfileData user)
	Creates a new user profile.
override void	AddNewUserAgent (UserAgentData agent)
	Creates a new user agent.
override bool	MoneyTransferRequest (UUID from, UUID to, uint amount)
	Transfers money between two user accounts.
override bool	InventoryTransferRequest (UUID from, UUID to, UUID item)
	Transfers inventory between two accounts.
override AvatarAppearance	GetUserAppearance (UUID user)
	Appearance. TODO: stubs for now to do in memory appearance.
override void	UpdateUserAppearance (UUID user, AvatarAppearance appearance)
	Update a user appearence.
override void	ResetAttachments (UUID userID)
override void	LogoutUsers (UUID regionID)
Properties
override string	Name [get]
	Returns the name of the storage provider.
override string	Version [get]
	Returns the version of the storage provider.

---

Detailed Description

A User storage interface for the SQLite database system.

---

Member Function Documentation

override void OpenSim::Data::SQLite::SQLiteUserData::Initialise

(

)

[inline, virtual]

Default-initialises the plugin.

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::Initialise

(

string

connect

)

[inline, virtual]

• Initialises User Interface
• Loads and initialises a new SQLite connection and maintains it.
• use default URI if connect string string is empty.

Parameters:

connect

connect string

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::Dispose

(

)

[inline, virtual]

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::SQLite::SQLiteUserData::GetUserByUUID

(

UUID

uuid

)

[inline, virtual]

see IUserDataPlugin, Get user data profile by UUID

Parameters:

uuid

User UUID

Returns:

user profile data

Implements OpenSim::Data::UserDataBase.

override UserProfileData OpenSim::Data::SQLite::SQLiteUserData::GetUserByName	(	string	fname,
		string	lname
	)			[inline, virtual]

see IUserDataPlugin, Get user data profile by name

Parameters:

	fname	first name
	lname	last name

Returns:

user profile data

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::AddNewUserFriend	(	UUID	friendlistowner,
		UUID	friend,
		uint	perms
	)			[inline, virtual]

Add a new friend in the friendlist.

Parameters:

	friendlistowner	UUID of the friendlist owner
	friend	UUID of the friend to add
	perms	permission flag

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::RemoveUserFriend	(	UUID	friendlistowner,
		UUID	friend
	)			[inline, virtual]

Remove a user from the friendlist.

Parameters:

	friendlistowner	UUID of the friendlist owner
	friend	UUID of the friend to remove

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::UpdateUserFriendPerms	(	UUID	friendlistowner,
		UUID	friend,
		uint	perms
	)			[inline, virtual]

Update the friendlist permission.

Parameters:

	friendlistowner	UUID of the friendlist owner
	friend	UUID of the friend to modify
	perms	updated permission flag

Implements OpenSim::Data::UserDataBase.

override List<FriendListItem> OpenSim::Data::SQLite::SQLiteUserData::GetUserFriendList

(

UUID

friendlistowner

)

[inline, virtual]

Get (fetch?) the friendlist for a user.

Parameters:

friendlistowner

UUID of the friendlist owner

Returns:

The friendlist list

Implements OpenSim::Data::UserDataBase.

override Dictionary<UUID, FriendRegionInfo> OpenSim::Data::SQLite::SQLiteUserData::GetFriendRegionInfos

(

List< UUID >

uuids

)

[inline, virtual]

Returns a list of <see cref="FriendRegionInfo/>s for the specified UUIDs.

Parameters:

uuids

A List of <see cref="UUID/>s to fetch info for

Returns:

A Dictionary, mapping the UUIDs to FriendRegionInfos.

Implements OpenSim::Data::UserDataBase.

override List<AvatarPickerAvatar> OpenSim::Data::SQLite::SQLiteUserData::GeneratePickerResults	(	UUID	queryID,
		string	query
	)			[inline, virtual]

Parameters:

	queryID
	query

Returns:

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::SQLite::SQLiteUserData::GetAgentByUUID

(

UUID

uuid

)

[inline, virtual]

Returns a user by UUID direct.

Parameters:

uuid

The user's account ID

Returns:

A matching user profile

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::SQLite::SQLiteUserData::GetAgentByName

(

string

name

)

[inline, virtual]

Returns a session by account name.

Parameters:

name

The account name

Returns:

The user's session agent

Implements OpenSim::Data::UserDataBase.

override UserAgentData OpenSim::Data::SQLite::SQLiteUserData::GetAgentByName	(	string	fname,
		string	lname
	)			[inline, virtual]

Returns a session by account name.

Parameters:

	fname	The first part of the user's account name
	lname	The second part of the user's account name

Returns:

A user agent

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::StoreWebLoginKey	(	UUID	AgentID,
		UUID	WebLoginKey
	)			[inline, virtual]

DEPRECATED? Store the weblogin key.

Parameters:

	AgentID	UUID of the user
	WebLoginKey	UUID of the weblogin

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::AddNewUserProfile

(

UserProfileData

user

)

[inline, virtual]

Creates a new user profile.

Parameters:

user

The profile to add to the database

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::SQLite::SQLiteUserData::UpdateUserProfile

(

UserProfileData

user

)

[inline, virtual]

Creates a new user profile.

Parameters:

user

The profile to add to the database

Returns:

True on success, false on error

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::AddNewUserAgent

(

UserAgentData

agent

)

[inline, virtual]

Creates a new user agent.

Parameters:

agent

The agent to add to the database

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::SQLite::SQLiteUserData::MoneyTransferRequest	(	UUID	from,
		UUID	to,
		uint	amount
	)			[inline, virtual]

Transfers money between two user accounts.

Parameters:

	from	Starting account
	to	End account
	amount	The amount to move

Returns:

Success?

Implements OpenSim::Data::UserDataBase.

override bool OpenSim::Data::SQLite::SQLiteUserData::InventoryTransferRequest	(	UUID	from,
		UUID	to,
		UUID	item
	)			[inline, virtual]

Transfers inventory between two accounts.

Move to inventory server

Parameters:

	from	Senders account
	to	Receivers account
	item	Inventory item

Returns:

Success?

Implements OpenSim::Data::UserDataBase.

override AvatarAppearance OpenSim::Data::SQLite::SQLiteUserData::GetUserAppearance

(

UUID

user

)

[inline, virtual]

Appearance. TODO: stubs for now to do in memory appearance.

Parameters:

user

The user UUID

Returns:

Avatar Appearence

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::UpdateUserAppearance	(	UUID	user,
		AvatarAppearance	appearance
	)			[inline, virtual]

Update a user appearence.

Parameters:

	user	the user UUID
	appearance	appearence

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::ResetAttachments

(

UUID

userID

)

[inline, virtual]

Implements OpenSim::Data::UserDataBase.

override void OpenSim::Data::SQLite::SQLiteUserData::LogoutUsers

(

UUID

regionID

)

[inline, virtual]

Implements OpenSim::Data::UserDataBase.

---

Property Documentation

override string OpenSim::Data::SQLite::SQLiteUserData::Name [get]

Returns the name of the storage provider.

Returns:

Storage provider name

Reimplemented from OpenSim::Data::UserDataBase.

override string OpenSim::Data::SQLite::SQLiteUserData::Version [get]

Returns the version of the storage provider.

Returns:

Storage provider version

Reimplemented from OpenSim::Data::UserDataBase.

---

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

• /home/sdague/opensim-docs/OpenSim/Data/SQLite/SQLiteUserData.cs

---