Skip to main content

ServiceMetadata

Assembly: ServiceStack.dll
View Source
Declaration
public class ServiceMetadata

Properties

OperationsMap

View Source
Declaration
public Dictionary<Type, Operation> OperationsMap { get; protected set; }

OperationsResponseMap

View Source
Declaration
public Dictionary<Type, Operation> OperationsResponseMap { get; protected set; }

OperationNamesMap

View Source
Declaration
public Dictionary<string, Operation> OperationNamesMap { get; protected set; }

RequestTypes

View Source
Declaration
public HashSet<Type> RequestTypes { get; protected set; }

ServiceTypes

View Source
Declaration
public HashSet<Type> ServiceTypes { get; protected set; }

ResponseTypes

View Source
Declaration
public HashSet<Type> ResponseTypes { get; protected set; }

ConfigureOperations

View Source
Declaration
public List<Action<Operation>> ConfigureOperations { get; protected set; }

ConfigureMetadataTypes

View Source
Declaration
public List<Action<MetadataType>> ConfigureMetadataTypes { get; protected set; }

Operations

View Source
Declaration
public IEnumerable<Operation> Operations { get; }

ForceInclude

View Source
Declaration
public HashSet<Type> ForceInclude { get; set; }

Methods

Add(Type, Type, Type)

View Source
Declaration
public void Add(Type serviceType, Type requestType, Type responseType)
Parameters
TypeName
System.TypeserviceType
System.TyperequestType
System.TyperesponseType

AfterInit()

View Source
Declaration
public void AfterInit()

GetOperationAssemblies()

View Source
Declaration
public List<Assembly> GetOperationAssemblies()
Returns

System.Collections.Generic.List<System.Reflection.Assembly>

GetOperationDtos()

View Source
Declaration
public List<OperationDto> GetOperationDtos()
Returns

System.Collections.Generic.List<ServiceStack.Host.OperationDto>

GetOperationsByTag(String)

View Source
Declaration
public List<Operation> GetOperationsByTag(string tag)
Returns

System.Collections.Generic.List<ServiceStack.Host.Operation>

Parameters
TypeName
System.Stringtag

GetOperationsByTags(String[])

View Source
Declaration
public List<Operation> GetOperationsByTags(string[] tags)
Returns

System.Collections.Generic.List<ServiceStack.Host.Operation>

Parameters
TypeName
System.String[]tags

GetOperation(Type)

View Source
Declaration
public Operation GetOperation(Type requestType)
Returns

ServiceStack.Host.Operation

Parameters
TypeName
System.TyperequestType

GetImplementedActions(Type, Type)

View Source
Declaration
public List<ActionMethod> GetImplementedActions(Type serviceType, Type requestType)
Returns

System.Collections.Generic.List<ServiceStack.Host.ActionMethod>

Parameters
TypeName
System.TypeserviceType
System.TyperequestType

GetRequestType(String)

View Source
Declaration
public Type GetRequestType(string requestDtoName)
Returns

System.Type

Parameters
TypeName
System.StringrequestDtoName

GetOperationType(String)

View Source
Declaration
public Type GetOperationType(string operationTypeName)
Returns

System.Type

Parameters
TypeName
System.StringoperationTypeName

GetServiceTypeByRequest(Type)

View Source
Declaration
public Type GetServiceTypeByRequest(Type requestType)
Returns

System.Type

Parameters
TypeName
System.TyperequestType

GetServiceTypeByResponse(Type)

View Source
Declaration
public Type GetServiceTypeByResponse(Type responseType)
Returns

System.Type

Parameters
TypeName
System.TyperesponseType

GetResponseTypeByRequest(Type)

View Source
Declaration
public Type GetResponseTypeByRequest(Type requestType)
Returns

System.Type

Parameters
TypeName
System.TyperequestType

GetAllOperationTypes()

View Source
Declaration
public List<Type> GetAllOperationTypes()
Returns

System.Collections.Generic.List<System.Type>

GetAllOperationNames()

View Source
Declaration
public List<string> GetAllOperationNames()
Returns

System.Collections.Generic.List<System.String>

GetOperationNamesForMetadata(IRequest)

View Source
Declaration
public List<string> GetOperationNamesForMetadata(IRequest httpReq)
Returns

System.Collections.Generic.List<System.String>

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq

GetOperationNamesForMetadata(IRequest, Format)

View Source
Declaration
public List<string> GetOperationNamesForMetadata(IRequest httpReq, Format format)
Returns

System.Collections.Generic.List<System.String>

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq
ServiceStack.Formatformat

IsAuthorized(Operation, IRequest, IAuthSession)

View Source
Declaration
public bool IsAuthorized(Operation operation, IRequest req, IAuthSession session)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Host.Operationoperation
ServiceStack.Web.IRequestreq
ServiceStack.Auth.IAuthSessionsession

IsAuthorizedAsync(Operation, IRequest, IAuthSession)

View Source
Declaration
public async Task<bool> IsAuthorizedAsync(Operation operation, IRequest req, IAuthSession session)
Returns

System.Threading.Tasks.Task<System.Boolean>

Parameters
TypeName
ServiceStack.Host.Operationoperation
ServiceStack.Web.IRequestreq
ServiceStack.Auth.IAuthSessionsession

IsVisible(IRequest, Operation)

View Source
Declaration
public bool IsVisible(IRequest httpReq, Operation operation)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq
ServiceStack.Host.Operationoperation

IsVisible(IRequest, Type)

View Source
Declaration
public bool IsVisible(IRequest httpReq, Type requestType)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq
System.TyperequestType

IsVisible(IRequest, Format, String)

View Source
Declaration
public bool IsVisible(IRequest httpReq, Format format, string operationName)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq
ServiceStack.Formatformat
System.StringoperationName

CanAccess(IRequest, Format, String)

View Source
Declaration
public bool CanAccess(IRequest httpReq, Format format, string operationName)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq
ServiceStack.Formatformat
System.StringoperationName

CanAccess(RequestAttributes, Format, String)

View Source
Declaration
public bool CanAccess(RequestAttributes reqAttrs, Format format, string operationName)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.RequestAttributesreqAttrs
ServiceStack.Formatformat
System.StringoperationName

CanAccess(Format, String)

View Source
Declaration
public bool CanAccess(Format format, string operationName)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Formatformat
System.StringoperationName

HasImplementation(Operation, Format)

View Source
Declaration
public bool HasImplementation(Operation operation, Format format)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Host.Operationoperation
ServiceStack.Formatformat

GetAllDtos()

View Source
Declaration
public HashSet<Type> GetAllDtos()
Returns

System.Collections.Generic.HashSet<System.Type>

FindDtoType(String)

View Source
Declaration
public Type FindDtoType(string typeName)
Returns

System.Type

Parameters
TypeName
System.StringtypeName

FindRoute(String, String)

View Source
Declaration
public RestPath FindRoute(string pathInfo, string method = "GET")
Returns

ServiceStack.Host.RestPath

Parameters
TypeName
System.StringpathInfo
System.Stringmethod

CreateRequestFromUrl(String, String)

View Source
Declaration
public object CreateRequestFromUrl(string relativeOrAbsoluteUrl, string method = "GET")
Returns

System.Object

Parameters
TypeName
System.StringrelativeOrAbsoluteUrl
System.Stringmethod

AddReferencedTypes(HashSet<Type>, Type)

View Source
Declaration
public static void AddReferencedTypes(HashSet<Type> to, Type type)
Parameters
TypeName
System.Collections.Generic.HashSet<System.Type>to
System.Typetype

IsDtoType(Type)

View Source
Declaration
public static bool IsDtoType(Type type)
Returns

System.Boolean

Parameters
TypeName
System.Typetype

GetMetadataTypesForOperation(IRequest, Operation)

View Source
Declaration
public List<MetadataType> GetMetadataTypesForOperation(IRequest httpReq, Operation op)
Returns

System.Collections.Generic.List<ServiceStack.MetadataType>

Parameters
TypeName
ServiceStack.Web.IRequesthttpReq
ServiceStack.Host.Operationop

GetAllSoapOperationTypes()

View Source
Declaration
public List<Type> GetAllSoapOperationTypes()
Returns

System.Collections.Generic.List<System.Type>

GetAllRoles()

View Source
Declaration
public List<string> GetAllRoles()
Returns

System.Collections.Generic.List<System.String>

GetAllPermissions()

View Source
Declaration
public List<string> GetAllPermissions()
Returns

System.Collections.Generic.List<System.String>

CreateRequestDto(Type, Object)

View Source
Declaration
public object CreateRequestDto(Type requestType, object dto)
Returns

System.Object

Parameters
TypeName
System.TyperequestType
System.Objectdto