Beamable SDK
Public Member Functions | List of all members
Beamable.Server.AdminOnlyCallableAttribute Class Reference

This type defines the Microservice method attribute for any Microservice method which can be called ONLY from a Microservice by a User account of Admin type. More...

Inheritance diagram for Beamable.Server.AdminOnlyCallableAttribute:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Server.AdminOnlyCallableAttribute:
Collaboration graph
[legend]

Public Member Functions

 AdminOnlyCallableAttribute (string pathnameOverride="")
 
- Public Member Functions inherited from Beamable.Server.ClientCallableAttribute
 ClientCallableAttribute (string pathnameOverride="", string[] requiredScopes=null)
 
- Public Member Functions inherited from Beamable.Server.CallableAttribute
 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...
 

Additional Inherited Members

- Static Public Attributes inherited from Beamable.Server.CallableAttribute
static readonly List< ParameterOfInterestUNSUPPORTED_PARAMETER_TYPES
 
- Protected Attributes inherited from Beamable.Server.CallableAttribute
string pathName = ""
 
- Properties inherited from Beamable.Server.CallableAttribute
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

This type defines the Microservice method attribute for any Microservice method which can be called ONLY from a Microservice by a User account of Admin type.

Related Links

Example

This demonstrates example usage from WITHIN a custom Beamable Microservice.

[AdminOnlyCallable]
private async void MyMicroserviceMethod()
{
// Do something...
}

img beamable-logo


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