OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule:
Collaboration graph
[legend]

Public Member Functions

void Initialise (IConfigSource source)
 This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...
 
void AddRegion (Scene scene)
 Adds the region. More...
 
void RemoveRegion (Scene scene)
 Removes the region. More...
 
void RegionLoaded (Scene scene)
 This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...
 
void Close ()
 Called as the instance is closed. More...
 
void ClassifiedsRequest (Object sender, string method, List< String > args)
 Handles the avatar classifieds request. More...
 
void ClassifiedInfoRequest (UUID queryClassifiedID, IClientAPI remoteClient)
 
void ClassifiedInfoUpdate (UUID queryclassifiedID, uint queryCategory, string queryName, string queryDescription, UUID queryParcelID, uint queryParentEstate, UUID querySnapshotID, Vector3 queryGlobalPos, byte queryclassifiedFlags, int queryclassifiedPrice, IClientAPI remoteClient)
 Classifieds info update. More...
 
void ClassifiedDelete (UUID queryClassifiedID, IClientAPI remoteClient)
 Classifieds delete. More...
 
void PicksRequest (Object sender, string method, List< String > args)
 Handles the avatar picks request. More...
 
void PickInfoRequest (Object sender, string method, List< String > args)
 Handles the pick info request. More...
 
void PickInfoUpdate (IClientAPI remoteClient, UUID pickID, UUID creatorID, bool topPick, string name, string desc, UUID snapshotID, int sortOrder, bool enabled)
 Updates the userpicks More...
 
void PickDelete (IClientAPI remoteClient, UUID queryPickID)
 Delete a Pick More...
 
void NotesRequest (Object sender, string method, List< String > args)
 Handles the avatar notes request. More...
 
void NotesUpdate (IClientAPI remoteClient, UUID queryTargetID, string queryNotes)
 Avatars the notes update. More...
 
void UpdateUserPreferences (bool imViaEmail, bool visible, IClientAPI remoteClient)
 Updates the user preferences. More...
 
void UserPreferencesRequest (IClientAPI remoteClient)
 Users the preferences request. More...
 
void AvatarInterestsUpdate (IClientAPI remoteClient, uint wantmask, string wanttext, uint skillsmask, string skillstext, string languages)
 Update the avatars interests . More...
 
void RequestAvatarProperties (IClientAPI remoteClient, UUID avatarID)
 
void AvatarPropertiesUpdate (IClientAPI remoteClient, UserProfileData newProfile)
 Updates the avatar properties. More...
 

Properties

Scene Scene [get, set]
 
IConfigSource Config [get, set]
 Gets or sets the ConfigSource. More...
 
string ProfileServerUri [get, set]
 Gets or sets the URI to the profile server. More...
 
bool Enabled [get, set]
 Gets or sets a value indicating whether this OpenSim.Region.Coremodules.UserProfiles.UserProfileModule is enabled. More...
 
string MyGatekeeper [get, set]
 
Type ReplaceableInterface [get, set]
 If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...
 
string Name [get]
 Gets the module name. More...
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string Name [get]
 
Type ReplaceableInterface [get]
 If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...
 

Detailed Description

Definition at line 57 of file UserProfileModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.AddRegion ( Scene  scene)
inline

Adds the region.

Parameters
sceneScene.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 176 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.AvatarInterestsUpdate ( IClientAPI  remoteClient,
uint  wantmask,
string  wanttext,
uint  skillsmask,
string  skillstext,
string  languages 
)
inline

Update the avatars interests .

Parameters
remoteClientRemote client.
wantmaskWantmask.
wanttextWanttext.
skillsmaskSkillsmask.
skillstextSkillstext.
languagesLanguages.

Definition at line 962 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.AvatarPropertiesUpdate ( IClientAPI  remoteClient,
UserProfileData  newProfile 
)
inline

Updates the avatar properties.

Parameters
remoteClientRemote client.
newProfileNew profile.

Definition at line 1088 of file UserProfileModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.ClassifiedDelete ( UUID  queryClassifiedID,
IClientAPI  remoteClient 
)
inline

Classifieds delete.

Parameters
queryClassifiedIDQuery classified I.
remoteClientRemote client.

Definition at line 525 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.ClassifiedInfoRequest ( UUID  queryClassifiedID,
IClientAPI  remoteClient 
)
inline

Definition at line 374 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.ClassifiedInfoUpdate ( UUID  queryclassifiedID,
uint  queryCategory,
string  queryName,
string  queryDescription,
UUID  queryParcelID,
uint  queryParentEstate,
UUID  querySnapshotID,
Vector3  queryGlobalPos,
byte  queryclassifiedFlags,
int  queryclassifiedPrice,
IClientAPI  remoteClient 
)
inline

Classifieds info update.

Parameters
queryclassifiedIDQueryclassified I.
queryCategoryQuery category.
queryNameQuery name.
queryDescriptionQuery description.
queryParcelIDQuery parcel I.
queryParentEstateQuery parent estate.
querySnapshotIDQuery snapshot I.
queryGlobalPosQuery global position.
queryclassifiedFlagsQueryclassified flags.
queryclassifiedPriceQueryclassified price.
remoteClientRemote client.

Definition at line 456 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.ClassifiedsRequest ( Object  sender,
string  method,
List< String >  args 
)
inline

Handles the avatar classifieds request.

Parameters
senderSender.
methodMethod.
argsArguments.

Definition at line 312 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.Close ( )
inline

Called as the instance is closed.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 246 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.Initialise ( IConfigSource  source)
inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters
sourceSource.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 139 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.NotesRequest ( Object  sender,
string  method,
List< String >  args 
)
inline

Handles the avatar notes request.

Parameters
senderSender.
methodMethod.
argsArguments.

Definition at line 819 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.NotesUpdate ( IClientAPI  remoteClient,
UUID  queryTargetID,
string  queryNotes 
)
inline

Avatars the notes update.

Parameters
remoteClientRemote client.
queryTargetIDQuery target I.
queryNotesQuery notes.

Definition at line 855 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.PickDelete ( IClientAPI  remoteClient,
UUID  queryPickID 
)
inline

Delete a Pick

Parameters
remoteClientRemote client.
queryPickIDQuery pick I.

Definition at line 789 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.PickInfoRequest ( Object  sender,
string  method,
List< String >  args 
)
inline

Handles the pick info request.

Parameters
senderSender.
methodMethod.
argsArguments.

Definition at line 621 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.PickInfoUpdate ( IClientAPI  remoteClient,
UUID  pickID,
UUID  creatorID,
bool  topPick,
string  name,
string  desc,
UUID  snapshotID,
int  sortOrder,
bool  enabled 
)
inline

Updates the userpicks

Parameters
remoteClientRemote client.
pickIDPick I.
creatorIDthe creator of the pick
topPickTop pick.
nameName.
descDesc.
snapshotIDSnapshot I.
sortOrderSort order.
enabledEnabled.

Definition at line 720 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.PicksRequest ( Object  sender,
string  method,
List< String >  args 
)
inline

Handles the avatar picks request.

Parameters
senderSender.
methodMethod.
argsArguments.

Definition at line 559 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.RegionLoaded ( Scene  scene)
inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters
sceneScene.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 221 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.RemoveRegion ( Scene  scene)
inline

Removes the region.

Parameters
sceneScene.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 206 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.RequestAvatarProperties ( IClientAPI  remoteClient,
UUID  avatarID 
)
inline

Implements OpenSim.Framework.IProfileModule.

Definition at line 985 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.UpdateUserPreferences ( bool  imViaEmail,
bool  visible,
IClientAPI  remoteClient 
)
inline

Updates the user preferences.

Parameters
imViaEmailIm via email.
visibleVisible.
remoteClientRemote client.

Definition at line 890 of file UserProfileModule.cs.

void OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.UserPreferencesRequest ( IClientAPI  remoteClient)
inline

Users the preferences request.

Parameters
remoteClientRemote client.

Definition at line 916 of file UserProfileModule.cs.

Property Documentation

IConfigSource OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.Config
getset

Gets or sets the ConfigSource.

The configuration

Definition at line 84 of file UserProfileModule.cs.

bool OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.Enabled
getset

Gets or sets a value indicating whether this OpenSim.Region.Coremodules.UserProfiles.UserProfileModule is enabled.

true if enabled; otherwise, false.

Definition at line 119 of file UserProfileModule.cs.

string OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.MyGatekeeper
getset

Definition at line 125 of file UserProfileModule.cs.

string OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.Name
get

Gets the module name.

The name of the module

Definition at line 257 of file UserProfileModule.cs.

string OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.ProfileServerUri
getset

Gets or sets the URI to the profile server.

The profile server URI.

Definition at line 96 of file UserProfileModule.cs.

Type OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.ReplaceableInterface
getset

If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules.

The replaceable interface.

Definition at line 239 of file UserProfileModule.cs.

Scene OpenSim.Region.CoreModules.Avatar.UserProfiles.UserProfileModule.Scene
getset

Definition at line 73 of file UserProfileModule.cs.


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