Ditto 4.7.2-rc.1
Loading...
Searching...
No Matches
Protected Member Functions | Properties | List of all members
DittoSDK.DittoConnectionRequest Class Reference

Contains information about a remote peer that has requested a connection. More...

Inheritance diagram for DittoSDK.DittoConnectionRequest:

Protected Member Functions

override unsafe void Dispose (bool disposing)
 

Properties

string PeerKeyString [get]
 The unique peer key of the remote peer.
 
Dictionary< string, object > PeerMetadata [get]
 
string PeerMetadataJsonString [get]
 JSON metadata associated with the remote peer.
 
Dictionary< string, object > IdentityServiceMetadata [get]
 Metadata for the remote peer that is provided by the identity service.
 
string IdentityServiceMetadataJsonString [get]
 JSON-encoded metadata for the remote peer that is provided by the identity service.
 
DittoConnectionType ConnectionType [get]
 The network transport of this connection request.
 

Detailed Description

Contains information about a remote peer that has requested a connection.

Connection requests and their authorization are scoped to a specific Ditto peer and connection type.

Property Documentation

◆ ConnectionType

DittoConnectionType DittoSDK.DittoConnectionRequest.ConnectionType
get

The network transport of this connection request.

Expect to receive separate connection requests for each network transport that connects the local and remote peer.

◆ IdentityServiceMetadata

Dictionary<string, object> DittoSDK.DittoConnectionRequest.IdentityServiceMetadata
get

Metadata for the remote peer that is provided by the identity service.

Use an authentication webhook to set this value. See Ditto's online documentation for more information on how to configure an authentication webhook.

Convenience property that wraps IdentityServiceMetadataJsonString.

◆ IdentityServiceMetadataJsonString

string DittoSDK.DittoConnectionRequest.IdentityServiceMetadataJsonString
get

JSON-encoded metadata for the remote peer that is provided by the identity service.

Use an authentication webhook to set this value. See Ditto's online documentation for more information on how to configure an authentication webhook.

◆ PeerKeyString

string DittoSDK.DittoConnectionRequest.PeerKeyString
get

The unique peer key of the remote peer.

See also
DittoPeer.PeerKeyString

◆ PeerMetadata

Dictionary<string, object> DittoSDK.DittoConnectionRequest.PeerMetadata
get

Metadata associated with the remote peer.

Empty dictionary if the remote peer has not set any metadata, or when this request is for a WebSocket connection (which does notcurrently support peer metadata).

Set peer metadata for the local peer using DittoPresence.SetPeerMetadata(Dictionary<string, object>) or DittoPresence.SetPeerMetadataJsonString(string).

Convenience property that wraps PeerMetadataJsonString.

◆ PeerMetadataJsonString

string DittoSDK.DittoConnectionRequest.PeerMetadataJsonString
get

JSON metadata associated with the remote peer.

JSON string representing an empty dictionary if the remote peer has not set any metadata, or when this request is for a WebSocket connection (which does not currently support peer metadata).

Set peer metadata for the local peer using DittoPresence.SetPeerMetadata(Dictionary<string, object>) or DittoPresence.SetPeerMetadataJsonString(string).