OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Services.Interfaces.IUserAgentService Interface Reference
Inheritance diagram for OpenSim.Services.Interfaces.IUserAgentService:
Inheritance graph
[legend]

Public Member Functions

bool LoginAgentToGrid (GridRegion source, AgentCircuitData agent, GridRegion gatekeeper, GridRegion finalDestination, bool fromLogin, out string reason)
 
void LogoutAgent (UUID userID, UUID sessionID)
 
GridRegion GetHomeRegion (UUID userID, out Vector3 position, out Vector3 lookAt)
 Returns the home region of a remote user. More...
 
Dictionary< string, object > GetServerURLs (UUID userID)
 Returns the Server URLs of a remote user. More...
 
Dictionary< string, object > GetUserInfo (UUID userID)
 Returns the UserInfo of a remote user. More...
 
string LocateUser (UUID userID)
 Returns the current location of a remote user. More...
 
string GetUUI (UUID userID, UUID targetUserID)
 Returns the Universal User Identifier for 'targetUserID' on behalf of 'userID'. More...
 
UUID GetUUID (String first, String last)
 Returns the remote user that has the given name. More...
 
List< UUID > StatusNotification (List< string > friends, UUID userID, bool online)
 
bool IsAgentComingHome (UUID sessionID, string thisGridExternalName)
 
bool VerifyAgent (UUID sessionID, string token)
 
bool VerifyClient (UUID sessionID, string reportedIP)
 

Detailed Description

Definition at line 59 of file IHypergridServices.cs.

Member Function Documentation

GridRegion OpenSim.Services.Interfaces.IUserAgentService.GetHomeRegion ( UUID  userID,
out Vector3  position,
out Vector3  lookAt 
)

Returns the home region of a remote user.

Returns
On success: the user's home region. If the user doesn't exist: null.

Throws an exception if an error occurs (e.g., can't contact the server).

Implemented in OpenSim.Services.Connectors.Hypergrid.UserAgentServiceConnector, and OpenSim.Services.HypergridService.UserAgentService.

Dictionary<string, object> OpenSim.Services.Interfaces.IUserAgentService.GetServerURLs ( UUID  userID)

Returns the Server URLs of a remote user.

Returns
On success: the user's Server URLs. If the user doesn't exist: an empty dictionary.

Throws an exception if an error occurs (e.g., can't contact the server).

Implemented in OpenSim.Services.HypergridService.UserAgentService, and OpenSim.Services.Connectors.Hypergrid.UserAgentServiceConnector.

Dictionary<string, object> OpenSim.Services.Interfaces.IUserAgentService.GetUserInfo ( UUID  userID)

Returns the UserInfo of a remote user.

Returns
On success: the user's UserInfo. If the user doesn't exist: an empty dictionary.

Throws an exception if an error occurs (e.g., can't contact the server).

Implemented in OpenSim.Services.HypergridService.UserAgentService, and OpenSim.Services.Connectors.Hypergrid.UserAgentServiceConnector.

string OpenSim.Services.Interfaces.IUserAgentService.GetUUI ( UUID  userID,
UUID  targetUserID 
)

Returns the Universal User Identifier for 'targetUserID' on behalf of 'userID'.

Returns
On success: the user's UUI. If the user doesn't exist: "".

Throws an exception if an error occurs (e.g., can't contact the server).

Implemented in OpenSim.Services.HypergridService.UserAgentService, and OpenSim.Services.Connectors.Hypergrid.UserAgentServiceConnector.

UUID OpenSim.Services.Interfaces.IUserAgentService.GetUUID ( String  first,
String  last 
)

Returns the remote user that has the given name.

Returns
On success: the user's UUID. If the user doesn't exist: UUID.Zero.

Throws an exception if an error occurs (e.g., can't contact the server).

Implemented in OpenSim.Services.HypergridService.UserAgentService, and OpenSim.Services.Connectors.Hypergrid.UserAgentServiceConnector.

bool OpenSim.Services.Interfaces.IUserAgentService.IsAgentComingHome ( UUID  sessionID,
string  thisGridExternalName 
)
string OpenSim.Services.Interfaces.IUserAgentService.LocateUser ( UUID  userID)

Returns the current location of a remote user.

Returns
On success: the user's Server URLs. If the user doesn't exist: "".

Throws an exception if an error occurs (e.g., can't contact the server).

Implemented in OpenSim.Services.HypergridService.UserAgentService, and OpenSim.Services.Connectors.Hypergrid.UserAgentServiceConnector.

bool OpenSim.Services.Interfaces.IUserAgentService.LoginAgentToGrid ( GridRegion  source,
AgentCircuitData  agent,
GridRegion  gatekeeper,
GridRegion  finalDestination,
bool  fromLogin,
out string  reason 
)
void OpenSim.Services.Interfaces.IUserAgentService.LogoutAgent ( UUID  userID,
UUID  sessionID 
)
List<UUID> OpenSim.Services.Interfaces.IUserAgentService.StatusNotification ( List< string >  friends,
UUID  userID,
bool  online 
)
bool OpenSim.Services.Interfaces.IUserAgentService.VerifyAgent ( UUID  sessionID,
string  token 
)
bool OpenSim.Services.Interfaces.IUserAgentService.VerifyClient ( UUID  sessionID,
string  reportedIP 
)

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