Base callable attribute used to identify methods to be exposed by microservices as endpoints. This attribute makes the endpoint publicly accessible (no need for authentication). ClientCallableAttribute forces the authentication to be required. AdminOnlyCallableAttribute makes it so that only an admin/developer can reach the endpoint. More...

Inheritance diagram for Beamable.Server.CallableAttribute:

[legend]

Collaboration diagram for Beamable.Server.CallableAttribute:

[legend]

Public Member Functions
	CallableAttribute (string pathnameOverride="", string[] requiredScopes=null, bool requireAuthenticatedUser=false)

virtual AttributeValidationResult	IsAllowedOnMember (MemberInfo member)
	Takes in the MemberInfo associated with this attribute and returns a AttributeValidationResult. More...

virtual AttributeValidationResult	AreValidNameForType (MemberInfo member, string[] potentialNames)
	A function that validates the list of names given to the implementing attribute instance. More...

Static Public Attributes
static readonly List< ParameterOfInterest >	UNSUPPORTED_PARAMETER_TYPES

Protected Attributes
string	pathName = ""

Properties
HashSet< string >	RequiredScopes `[get]`

bool	RequireAuthenticatedUser `[get]`

string	PathName `[getset]`

string[]	Names `[get]`

Properties inherited from Beamable.Common.Reflection.INamingAttribute
string[]	Names `[get]`
	A list of names that must be unique between all uses of the implementing attribute.

Detailed Description

Base callable attribute used to identify methods to be exposed by microservices as endpoints. This attribute makes the endpoint publicly accessible (no need for authentication). ClientCallableAttribute forces the authentication to be required. AdminOnlyCallableAttribute makes it so that only an admin/developer can reach the endpoint.

Member Function Documentation

◆ AreValidNameForType()

virtual AttributeValidationResult Beamable.Server.CallableAttribute.AreValidNameForType	(	MemberInfo	member,
		string[]	potentialNames
	)

inlinevirtual

A function that validates the list of names given to the implementing attribute instance.

Returns: An AttributeValidationResult<T> with a clear message and ReflectionCache.ValidationResultType.

Implements Beamable.Common.Reflection.INamingAttribute.

◆ IsAllowedOnMember()

virtual AttributeValidationResult Beamable.Server.CallableAttribute.IsAllowedOnMember ( MemberInfo member )

inlinevirtual

Takes in the MemberInfo associated with this attribute and returns a AttributeValidationResult.

Implements Beamable.Common.Reflection.IReflectionAttribute.

Member Data Documentation

◆ UNSUPPORTED_PARAMETER_TYPES

readonly List<ParameterOfInterest> Beamable.Server.CallableAttribute.UNSUPPORTED_PARAMETER_TYPES

static

Initial value:

= new List<ParameterOfInterest>()
        {
            new ParameterOfInterest(typeof(Delegate), false, false, false),
            new ParameterOfInterest(typeof(Task), false, false, false),
            new ParameterOfInterest(typeof(Promise), false, false, false),
        }

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

com.beamable.server/SharedRuntime/ClientCallableAttribute.cs

Public Member Functions

Static Public Attributes