Buzzware.Cascade.ICascadeOrigin Interface Reference

Defines a Cascade Origin, with methods to process requests, manage authentication, and interact with model types in the Cascade framework. More...

Inheritance diagram for Buzzware.Cascade.ICascadeOrigin:

Public Member Functions
Task< OpResponse >	ProcessRequest (RequestOp request, bool connectionOnline)
	Receives a request and returns a response eg. from a server.
Task	EnsureAuthenticated (Type? type=null)
	Ensures that the session is authenticated, potentially for a specific type.
Type	LookupModelType (string typeName)
	Retrieves the model type based on the provided type name.
string	NewGuid ()
	Generates a new GUID as a string.
IEnumerable< Type >	ListModelTypes ()
	Lists all the model types registered.

Properties
CascadeDataLayer	Cascade [get, set]
	CascadeDataLayer reference.
long	NowMs [get]
	Current time in milliseconds since 1970.

Detailed Description

Defines a Cascade Origin, with methods to process requests, manage authentication, and interact with model types in the Cascade framework.

Member Function Documentation

EnsureAuthenticated()

Task Buzzware.Cascade.ICascadeOrigin.EnsureAuthenticated

(

Type?

type = null

)

Ensures that the session is authenticated, potentially for a specific type.

Parameters

type	The type for which authentication is being ensured. Defaults to null.

Returns

A task representing the authentication process.

Implemented in Buzzware.Cascade.Testing.MockOrigin.

ListModelTypes()

IEnumerable< Type > Buzzware.Cascade.ICascadeOrigin.ListModelTypes

(

)

Lists all the model types registered.

Returns

An enumerable containing all registered model types.

Implemented in Buzzware.Cascade.Testing.MockOrigin.

LookupModelType()

Type Buzzware.Cascade.ICascadeOrigin.LookupModelType

(

string

typeName

)

Retrieves the model type based on the provided type name.

Parameters

typeName

The name of the type to be looked up.

Returns

The Type corresponding to the provided type name.

Implemented in Buzzware.Cascade.Testing.MockOrigin, and Buzzware.Cascade.Testing.MockOrigin2.

NewGuid()

string Buzzware.Cascade.ICascadeOrigin.NewGuid

(

)

Generates a new GUID as a string.

Returns

A string representing a new GUID.

Implemented in Buzzware.Cascade.Testing.MockOrigin.

ProcessRequest()

Task< OpResponse > Buzzware.Cascade.ICascadeOrigin.ProcessRequest	(	RequestOp	request,
		bool	connectionOnline )

Receives a request and returns a response eg. from a server.

Parameters

request	The request operation to be processed.
connectionOnline	Indicates whether the connection is currently online.

Returns

A task returning an OpResponse indicating the outcome of the request.

Implemented in Buzzware.Cascade.Testing.MockOrigin, and Buzzware.Cascade.Testing.MockOrigin2.

Property Documentation

Cascade

CascadeDataLayer Buzzware.Cascade.ICascadeOrigin.Cascade

getset

CascadeDataLayer reference.

Implemented in Buzzware.Cascade.Testing.MockOrigin.

NowMs

long Buzzware.Cascade.ICascadeOrigin.NowMs

get

Current time in milliseconds since 1970.

Implemented in Buzzware.Cascade.Testing.MockOrigin.

---

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

• Buzzware.Cascade/interfaces/ICascadeOrigin.cs