OpenSim::Framework::Communications::IUserService

OpenSim::Framework::Communications::IUserService Interface Reference

Inheritance diagram for OpenSim::Framework::Communications::IUserService:

OpenSim::Framework::Communications::UserManagerBase OpenSim::Region::Communications::Hypergrid::HGUserServices OpenSim::Region::Communications::OGS1::OGS1UserServices OpenSim::Grid::MessagingServer::UserManager OpenSim::Grid::UserServer::UserManager OpenSim::Region::Communications::Local::LocalUserServices List of all members.

Public Member Functions

UserProfileData GetUserProfile (string firstName, string lastName)
 Loads a user profile by name.
UserProfileData GetUserProfile (UUID userId)
 Loads a user profile from a database by UUID.
UserAgentData GetAgentByUUID (UUID userId)
void ClearUserAgent (UUID avatarID)
List< AvatarPickerAvatar > GenerateAgentPickerRequestResponse (UUID QueryID, string Query)
UserProfileData SetupMasterUser (string firstName, string lastName)
UserProfileData SetupMasterUser (string firstName, string lastName, string password)
UserProfileData SetupMasterUser (UUID userId)
bool UpdateUserProfile (UserProfileData data)
 Update the user's profile.
void AddNewUserFriend (UUID friendlistowner, UUID friend, uint perms)
 Adds a new friend to the database for XUser.
void RemoveUserFriend (UUID friendlistowner, UUID friend)
 Delete friend on friendlistowner's friendlist.
void UpdateUserFriendPerms (UUID friendlistowner, UUID friend, uint perms)
 Update permissions for friend on friendlistowner's friendlist.
void LogOffUser (UUID userid, UUID regionid, ulong regionhandle, Vector3 position, Vector3 lookat)
 Logs off a user on the user server.
void LogOffUser (UUID userid, UUID regionid, ulong regionhandle, float posx, float posy, float posz)
 Logs off a user on the user server (deprecated as of 2008-08-27).
List< FriendListItem > GetUserFriendList (UUID friendlistowner)
 Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.

Member Function Documentation

UserProfileData OpenSim::Framework::Communications::IUserService::GetUserProfile ( string  firstName,
string  lastName 
)

Loads a user profile by name.

Parameters:
firstName First name
lastName Last name
Returns:
A user profile. Returns null if no profile is found

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

UserProfileData OpenSim::Framework::Communications::IUserService::GetUserProfile ( UUID  userId  ) 

Loads a user profile from a database by UUID.

Parameters:
userId The target UUID
Returns:
A user profile. Returns null if no user profile is found.

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

UserAgentData OpenSim::Framework::Communications::IUserService::GetAgentByUUID ( UUID  userId  ) 

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

void OpenSim::Framework::Communications::IUserService::ClearUserAgent ( UUID  avatarID  ) 

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

List<AvatarPickerAvatar> OpenSim::Framework::Communications::IUserService::GenerateAgentPickerRequestResponse ( UUID  QueryID,
string  Query 
)

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

UserProfileData OpenSim::Framework::Communications::IUserService::SetupMasterUser ( string  firstName,
string  lastName 
)

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Grid::MessagingServer::UserManager, OpenSim::Grid::UserServer::UserManager, OpenSim::Region::Communications::Hypergrid::HGUserServices, OpenSim::Region::Communications::Local::LocalUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

UserProfileData OpenSim::Framework::Communications::IUserService::SetupMasterUser ( string  firstName,
string  lastName,
string  password 
)

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Grid::MessagingServer::UserManager, OpenSim::Grid::UserServer::UserManager, OpenSim::Region::Communications::Hypergrid::HGUserServices, OpenSim::Region::Communications::Local::LocalUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

UserProfileData OpenSim::Framework::Communications::IUserService::SetupMasterUser ( UUID  userId  ) 

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Grid::MessagingServer::UserManager, OpenSim::Grid::UserServer::UserManager, OpenSim::Region::Communications::Hypergrid::HGUserServices, OpenSim::Region::Communications::Local::LocalUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

bool OpenSim::Framework::Communications::IUserService::UpdateUserProfile ( UserProfileData  data  ) 

Update the user's profile.

Parameters:
data UserProfileData object with updated data. Should be obtained via a call to GetUserProfile().
Returns:
true if the update could be applied, false if it could not be applied.

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

void OpenSim::Framework::Communications::IUserService::AddNewUserFriend ( UUID  friendlistowner,
UUID  friend,
uint  perms 
)

Adds a new friend to the database for XUser.

Parameters:
friendlistowner The agent that who's friends list is being added to
friend The agent that being added to the friends list of the friends list owner
perms A uint bit vector for set perms that the friend being added has; 0 = none, 1=This friend can see when they sign on, 2 = map, 4 edit objects

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

void OpenSim::Framework::Communications::IUserService::RemoveUserFriend ( UUID  friendlistowner,
UUID  friend 
)

Delete friend on friendlistowner's friendlist.

Parameters:
friendlistowner The agent that who's friends list is being updated
friend The Ex-friend agent

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

void OpenSim::Framework::Communications::IUserService::UpdateUserFriendPerms ( UUID  friendlistowner,
UUID  friend,
uint  perms 
)

Update permissions for friend on friendlistowner's friendlist.

Parameters:
friendlistowner The agent that who's friends list is being updated
friend The agent that is getting or loosing permissions
perms A uint bit vector for set perms that the friend being added has; 0 = none, 1=This friend can see when they sign on, 2 = map, 4 edit objects

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

void OpenSim::Framework::Communications::IUserService::LogOffUser ( UUID  userid,
UUID  regionid,
ulong  regionhandle,
Vector3  position,
Vector3  lookat 
)

Logs off a user on the user server.

Parameters:
userid UUID of the user
regionid UUID of the Region
regionhandle regionhandle
position final position
lookat final lookat

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

void OpenSim::Framework::Communications::IUserService::LogOffUser ( UUID  userid,
UUID  regionid,
ulong  regionhandle,
float  posx,
float  posy,
float  posz 
)

Logs off a user on the user server (deprecated as of 2008-08-27).

Parameters:
userid UUID of the user
regionid UUID of the Region
regionhandle regionhandle
posx final position x
posy final position y
posz final position z

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

List<FriendListItem> OpenSim::Framework::Communications::IUserService::GetUserFriendList ( UUID  friendlistowner  ) 

Returns a list of FriendsListItems that describe the friends and permissions in the friend relationship for UUID friendslistowner.

Parameters:
friendlistowner The agent that we're retreiving the friends Data.

Implemented in OpenSim::Framework::Communications::UserManagerBase, OpenSim::Region::Communications::Hypergrid::HGUserServices, and OpenSim::Region::Communications::OGS1::OGS1UserServices.

The documentation for this interface was generated from the following file:
Generated on Fri Jan 9 01:00:46 2009 for OpenSim by  doxygen 1.5.1