Difference between revisions of "IConnectionIdentity"
From Virtual World Web Wiki
(Documentation for the IConnectionIdentity class) |
(Documentation for the IConnectionIdentity class) |
||
Line 2: | Line 2: | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:IConnectionIdentity Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:IConnectionIdentity Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
− | {{:IConnectionIdentity Remarks}} | + | {{#ifexist:IConnectionIdentity Remarks|{{:IConnectionIdentity Remarks}}|}} |
===Properties=== | ===Properties=== |
Revision as of 21:04, 12 April 2017
Represents a user connected to the system and a Layer One Connection Identity, their identity details (entity memberships), current location and Participant, and provides access to many other Layer One objects related to the connection
Remarks [edit]
Properties
- IAbilitySet AbilitySet {get;}
- Access to the ability manager for the connection. use this to create, enable, disable, and fire abilities
- Guid ConnectionID {get;}
- The ID of the unique connection to the instance host
- CultureInfo Culture {get;}
- The culture of the current identity
- IExperienceData ExperienceData {get;}
- Gets client experience metrics for this connection
- IInstanceContext InstanceContext {get;}
- Gets the current instance context
- bool IsConnected {get;}
- Determines if this identity is currently connected
- ILocationInfo Location {get;}
- The connection's current location
- IParticipant Participant {get;}
- When on the instance host, if this connection is in a room, this property will return a reference to the participant
- IPAddress RemoteAddress {get;}
- The connection endpoint for packets
- Guid SessionID {get;}
- The ID of the session with the network. This remains constant even as a user connects and re-connects and switches servers
- ConcurrentDictionary<string, object> SessionState {get;}
- A collection of objects that should be marshalled between servers with the session
- DOMObject Target {get;}
- Gets the currently Targeted object
- IUserAgentInfo UserAgentInfo {get;}
- Provides information about the user agent connected
Methods
- void ConfirmDialog(AutoString message, Action<bool> responseCallback)
- Sends a translatable message to the connected client, and calls back to let you know if they confirmed your question or not. This is implementation dependant.
- Uri CreateWebTransferToken(string uri)
- Create a web transfer key, and inserts it into the uri provided. Returns an absolute Uri with the token inserted. If the uri is relative, the result is relative to the WebView root, otherwise the token is simply added as a query string parameter.
- string CreateWebTransferToken()
- Creates a raw Web Transfer token which can be passed to EntitySystem.ConsumeWebTransferToken during the next 60 seconds to get back this connection's AccountID
- void Disconnect(bool graceful = true)
- Disconnects the user
- DOMView GetAccessibleView(ViewTarget target)
- Gets the accessable view target of the specified type
- IEnumerable<DOMView> GetAccessibleViews(ViewTarget targets)
- Gets the accessable view targets of the specified types
- DOMController GetController()
- Looks up this connections current DOMController object from it's persona view
- IEnumerable<DOMObject> GetObjectSelection()
- Gets the currently selected DOMObject collection
- void GrantViewAccess(ViewTarget target)
- Grants access to the specified views
- bool IsFriend(IConnectionIdentity other)
- Determines if this connection Identity has a friendship relationship with other
- bool IsFriend(Guid personaID)
- Determines if this connection Identity has a friendship relationship with a given persona ID
- bool IsIgnoring(IConnectionIdentity other)
- Determines if this connection Identity has an ignore relationship against the other
- bool IsIgnoring(Guid personaID)
- Determines if this connection Identity has an ignore relationship against another persona ID
- void MoveToObject(long objectID, float minDistance, bool pathTo)
- Requests that the client make best effort to move the player's avatar next to and facing the requested object
- void Navigate(ILocationInfo location, bool switchPersona = false, Action<PacketErrorStatus, string> completion = NULL)
- Navigates this connection to a new location
- void Navigate(Uri vwwUri, bool designMode, Guid? instanceID = NULL)
- Navigates this connection to a new location given a vwwurl
- void Navigate(Guid sceneID, Guid instanceID, bool designMode)
- Navigates this connection to a new location given a scene and instance
- void Navigate(Guid instanceID)
- Navigates this connection to a neighboring instance of the same scene
- void RevokeAllViewAccess()
- Revokes access to all views
- void RevokeViewAccess(ViewTarget target)
- Revokes access to the specified views
- void SendChatMessage(AutoString message, ColorLevelPreSets colorLevel = ColorLevelPreSets.System)
- Sends a translated priority server message to the client as a chat message in their current general chat channel
- void SendChatMessage(AutoString message, Guid? channelID, ColorLevelPreSets colorLevel = ColorLevelPreSets.System)
- Sends a translated priority server message to the client as a chat message
- void SendServerMessage(AutoString message)
- Sends a translated priority server message to the client
- string ToString(string format)
- Gets the formated string version of this object
- bool TryGetController(out DOMController controller)
- bool VerifyViewAccess(DOMObject node)
- Gets the current accessable view targets