C# Class Goedel.Mesh.MeshClient

High level Mesh Client interface.

Exibir arquivo Open project: hallambaker/Mathematical-Mesh Class Usage Examples

Public Properties

Property	Type	Description
AccountID	string
AccountName	string
Portal	string
UDF	string

Protected Properties

Property	Type	Description
MeshService	MeshService

Public Methods

Method	Description
ConnectClose ( SignedConnectionRequest SignedConnectionRequest, ConnectionStatus ConnectionStatus ) : ConnectCompleteResponse	Close a pending device connection request.
ConnectPending ( ) : ConnectPendingResponse	Get a list of pending device connection requests.
ConnectRequest ( SignedDeviceProfile SignedDeviceProfile ) : ConnectStartResponse	Initiate a device connection request.
ConnectStatus ( string UDF ) : ConnectStatusResponse	Get status for a pending device connection request.
CreatePersonalProfile ( string AccountID, SignedPersonalProfile SignedCurrentProfile ) : CreateResponse	Create a new account and set the personal profile
GetApplicationProfile ( string ID ) : SignedApplicationProfile	Retrieve an application profile by unique ID.
GetMailProfile ( ) : MailProfile	Retreive the default mail profile.
GetNetworkProfile ( ) : NetworkProfile	Retreive the default network profile.
GetPasswordProfile ( ) : PasswordProfile	Retreive the default password profile.
GetPersonalProfile ( ) : SignedPersonalProfile	Get the active profile associated with the current account.
MakeDefault ( string UDF ) : void	Make the current portal and account name the default
MeshClient ( string Portal ) : System	Connect up to the specified Mesh Portal
MeshClient ( string Portal, string AccountID ) : System	Connect up to a specified Mesh Portal and account.
Publish ( OfflineEscrowEntry OfflineEscrowEntry ) : PublishResponse	Publish an offline escrow entry to the mesh.
Publish ( SignedProfile SignedProfile ) : PublishResponse	Publish a signed profile entry to the mesh.
Recover ( string Identifier ) : OfflineEscrowEntry	Recover an offline escrow entry
Validate ( string Account ) : ValidateResponse	Check to see if an account name is acceptable for use at a portal. Note that a positive response to a validation request does not guarantee that the account name will be available for a subsequent call to CreatePersonalProfile.

Method Details

ConnectClose() public method

Close a pending device connection request.

public ConnectClose ( SignedConnectionRequest SignedConnectionRequest, ConnectionStatus ConnectionStatus ) : ConnectCompleteResponse
SignedConnectionRequest	SignedConnectionRequest	The connection request to close.
ConnectionStatus	ConnectionStatus	The status to set.
return	ConnectCompleteResponse

ConnectPending() public method

Get a list of pending device connection requests.

public ConnectPending ( ) : ConnectPendingResponse
return	ConnectPendingResponse

ConnectRequest() public method

Initiate a device connection request.

public ConnectRequest ( SignedDeviceProfile SignedDeviceProfile ) : ConnectStartResponse
SignedDeviceProfile	SignedDeviceProfile	The device profile to register.
return	ConnectStartResponse

ConnectStatus() public method

Get status for a pending device connection request.

public ConnectStatus ( string UDF ) : ConnectStatusResponse
UDF	string	Fingerprint of the device that requested the connection.
return	ConnectStatusResponse

CreatePersonalProfile() public method

Create a new account and set the personal profile

public CreatePersonalProfile ( string AccountID, SignedPersonalProfile SignedCurrentProfile ) : CreateResponse
AccountID	string	The requested account identifier.
SignedCurrentProfile	SignedPersonalProfile	The personal profile to use.
return	CreateResponse

GetApplicationProfile() public method

Retrieve an application profile by unique ID.

public GetApplicationProfile ( string ID ) : SignedApplicationProfile
ID	string	the unique id of the profile.
return	SignedApplicationProfile

GetMailProfile() public method

Retreive the default mail profile.

public GetMailProfile ( ) : MailProfile
return	MailProfile

GetNetworkProfile() public method

Retreive the default network profile.

public GetNetworkProfile ( ) : NetworkProfile
return	NetworkProfile

GetPasswordProfile() public method

Retreive the default password profile.

public GetPasswordProfile ( ) : PasswordProfile
return	PasswordProfile

GetPersonalProfile() public method

Get the active profile associated with the current account.

public GetPersonalProfile ( ) : SignedPersonalProfile
return	SignedPersonalProfile

MakeDefault() public method

Make the current portal and account name the default

public MakeDefault ( string UDF ) : void
UDF	string	Fingerprint of the profile to make default.
return	void

MeshClient() public method

Connect up to the specified Mesh Portal

public MeshClient ( string Portal ) : System
Portal	string	The portal to connect to.
return	System

MeshClient() public method

Connect up to a specified Mesh Portal and account.

public MeshClient ( string Portal, string AccountID ) : System
Portal	string	The portal to connect to.
AccountID	string	The account identifier.
return	System

Publish() public method

Publish an offline escrow entry to the mesh.

public Publish ( OfflineEscrowEntry OfflineEscrowEntry ) : PublishResponse
OfflineEscrowEntry	OfflineEscrowEntry	The escrow entry to publish
return	PublishResponse

Publish() public method

Publish a signed profile entry to the mesh.

public Publish ( SignedProfile SignedProfile ) : PublishResponse
SignedProfile	SignedProfile	The profile to publish
return	PublishResponse

Recover() public method

Recover an offline escrow entry

public Recover ( string Identifier ) : OfflineEscrowEntry
Identifier	string	The UDF of the decryption key
return	OfflineEscrowEntry

Validate() public method

Check to see if an account name is acceptable for use at a portal. Note that a positive response to a validation request does not guarantee that the account name will be available for a subsequent call to CreatePersonalProfile.

public Validate ( string Account ) : ValidateResponse
Account	string	The requested account name.
return	ValidateResponse

Property Details

AccountID public_oe property

The account Identifier.

public string AccountID
return	string

AccountName public_oe property

The account name.

public string AccountName
return	string

MeshService protected_oe property

The MeshProtocol Service provider.

protected MeshService,Goedel.Mesh MeshService
return	MeshService

Portal public_oe property

The portal address.

public string Portal
return	string

UDF public_oe property

Fingerprint of the Personal Profile.

public string UDF
return	string