ServiceExtensions

Assembly: ServiceStack.dll

View Source

Declaration

public static class ServiceExtensions

Fields

Log

View Source

Declaration

public static ILog Log

Methods

Redirect(IServiceBase, String)

View Source

Declaration

public static IHttpResult Redirect(this IServiceBase service, string redirect)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.String	redirect

Redirect(IServiceBase, String, String)

View Source

Declaration

public static IHttpResult Redirect(this IServiceBase service, string redirect, string message)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.String	redirect
System.String	message

LocalRedirect(IServiceBase, String)

View Source

Declaration

public static IHttpResult LocalRedirect(this IServiceBase service, string redirect)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.String	redirect

LocalRedirect(IServiceBase, String, String)

View Source

Declaration

public static IHttpResult LocalRedirect(this IServiceBase service, string redirect, string message)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.String	redirect
System.String	message

AuthenticationRequired(IServiceBase)

View Source

Declaration

public static IHttpResult AuthenticationRequired(this IServiceBase service)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	service

GetSessionId(IServiceBase)

View Source

Declaration

public static string GetSessionId(this IServiceBase service)

Returns

System.String

Parameters

Type	Name
ServiceStack.IServiceBase	service

GetCacheClient(IRequest)

View Source

Declaration

public static ICacheClient GetCacheClient(this IRequest request)

Returns

ServiceStack.Caching.ICacheClient

Parameters

Type	Name
ServiceStack.Web.IRequest	request

GetCacheClientAsync(IRequest)

View Source

Declaration

public static ICacheClientAsync GetCacheClientAsync(this IRequest request)

Returns

ServiceStack.Caching.ICacheClientAsync

Parameters

Type	Name
ServiceStack.Web.IRequest	request

GetMemoryCacheClient(IRequest)

View Source

Declaration

public static ICacheClient GetMemoryCacheClient(this IRequest request)

Returns

ServiceStack.Caching.ICacheClient

Parameters

Type	Name
ServiceStack.Web.IRequest	request

SaveSession(IServiceBase, IAuthSession, Nullable<TimeSpan>)

View Source

Declaration

[Obsolete("Use SaveSessionAsync")]
public static void SaveSession(this IServiceBase service, IAuthSession session, TimeSpan? expiresIn = null)

Parameters

Type	Name
ServiceStack.IServiceBase	service
ServiceStack.Auth.IAuthSession	session
System.Nullable<System.TimeSpan>	expiresIn

SaveSessionAsync(IServiceBase, IAuthSession, Nullable<TimeSpan>, CancellationToken)

View Source

Declaration

public static async Task SaveSessionAsync(this IServiceBase service, IAuthSession session, TimeSpan? expiresIn = null, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.IServiceBase	service
ServiceStack.Auth.IAuthSession	session
System.Nullable<System.TimeSpan>	expiresIn
System.Threading.CancellationToken	token

RemoveSession(IServiceBase)

View Source

Declaration

public static void RemoveSession(this IServiceBase service)

Parameters

Type	Name
ServiceStack.IServiceBase	service

RemoveSessionAsync(IServiceBase, CancellationToken)

View Source

Declaration

public static Task RemoveSessionAsync(this IServiceBase service, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.Threading.CancellationToken	token

RemoveSession(Service)

View Source

Declaration

public static void RemoveSession(this Service service)

Parameters

Type	Name
ServiceStack.Service	service

RemoveSessionAsync(Service, CancellationToken)

View Source

Declaration

public static Task RemoveSessionAsync(this Service service, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.Service	service
System.Threading.CancellationToken	token

CacheSet<T>(ICacheClient, String, T, Nullable<TimeSpan>)

View Source

Declaration

public static void CacheSet<T>(this ICacheClient cache, string key, T value, TimeSpan? expiresIn)

Parameters

Type	Name
ServiceStack.Caching.ICacheClient	cache
System.String	key
<T>	value
System.Nullable<System.TimeSpan>	expiresIn

Type Parameters

• T

CacheSetAsync<T>(ICacheClientAsync, String, T, Nullable<TimeSpan>, CancellationToken)

View Source

Declaration

public static async Task CacheSetAsync<T>(this ICacheClientAsync cache, string key, T value, TimeSpan? expiresIn, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.Caching.ICacheClientAsync	cache
System.String	key
<T>	value
System.Nullable<System.TimeSpan>	expiresIn
System.Threading.CancellationToken	token

Type Parameters

• T

SaveSession(IRequest, IAuthSession, Nullable<TimeSpan>)

View Source

Declaration

[Obsolete("Use SaveSessionAsync")]
public static void SaveSession(this IRequest httpReq, IAuthSession session, TimeSpan? expiresIn = null)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
ServiceStack.Auth.IAuthSession	session
System.Nullable<System.TimeSpan>	expiresIn

SaveSessionAsync(IRequest, IAuthSession, Nullable<TimeSpan>, CancellationToken)

View Source

Declaration

public static Task SaveSessionAsync(this IRequest httpReq, IAuthSession session, TimeSpan? expiresIn = null, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
ServiceStack.Auth.IAuthSession	session
System.Nullable<System.TimeSpan>	expiresIn
System.Threading.CancellationToken	token

RemoveSession(IRequest)

View Source

Declaration

public static void RemoveSession(this IRequest httpReq)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

RemoveSessionAsync(IRequest, CancellationToken)

View Source

Declaration

public static Task RemoveSessionAsync(this IRequest httpReq, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Threading.CancellationToken	token

RemoveSession(IRequest, String)

View Source

Declaration

public static void RemoveSession(this IRequest httpReq, string sessionId)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	sessionId

RemoveSessionAsync(IRequest, String, CancellationToken)

View Source

Declaration

public static async Task RemoveSessionAsync(this IRequest httpReq, string sessionId, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	sessionId
System.Threading.CancellationToken	token

GetSession(IServiceBase, Boolean)

View Source

Declaration

public static IAuthSession GetSession(this IServiceBase service, bool reload = false)

Returns

ServiceStack.Auth.IAuthSession

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.Boolean	reload

GetSessionAsync(IServiceBase, Boolean, CancellationToken)

View Source

Declaration

public static Task<IAuthSession> GetSessionAsync(this IServiceBase service, bool reload = false, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<ServiceStack.Auth.IAuthSession>

Parameters

Type	Name
ServiceStack.IServiceBase	service
System.Boolean	reload
System.Threading.CancellationToken	token

SessionAs<TUserSession>(IRequest)

View Source

Declaration

public static TUserSession SessionAs<TUserSession>(this IRequest req)

Returns

<TUserSession>

Parameters

Type	Name
ServiceStack.Web.IRequest	req

Type Parameters

• TUserSession

SessionAsAsync<TUserSession>(IRequest, CancellationToken)

View Source

Declaration

public static async Task<TUserSession> SessionAsAsync<TUserSession>(this IRequest req, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<<TUserSession>>

Parameters

Type	Name
ServiceStack.Web.IRequest	req
System.Threading.CancellationToken	token

Type Parameters

• TUserSession

IsAuthenticated(IRequest)

View Source

Declaration

[Obsolete("Use IsAuthenticatedAsync")]
public static bool IsAuthenticated(this IRequest req)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	req

IsAuthenticatedAsync(IRequest)

View Source

Declaration

public static Task<bool> IsAuthenticatedAsync(this IRequest req)

Returns

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

Parameters

Type	Name
ServiceStack.Web.IRequest	req

AssertAuthenticatedSession(IRequest, Boolean)

View Source

Declaration

public static IAuthSession AssertAuthenticatedSession(this IRequest req, bool reload = false)

Returns

ServiceStack.Auth.IAuthSession

Parameters

Type	Name
ServiceStack.Web.IRequest	req
System.Boolean	reload

AssertAuthenticatedSessionAsync(IRequest, Boolean, CancellationToken)

View Source

Declaration

public static async Task<IAuthSession> AssertAuthenticatedSessionAsync(this IRequest req, bool reload = false, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<ServiceStack.Auth.IAuthSession>

Parameters

Type	Name
ServiceStack.Web.IRequest	req
System.Boolean	reload
System.Threading.CancellationToken	token

GetSession(IRequest, Boolean)

View Source

Declaration

public static IAuthSession GetSession(this IRequest httpReq, bool reload = false)

Returns

ServiceStack.Auth.IAuthSession

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Boolean	reload

GetSessionAsync(IRequest, Boolean, CancellationToken)

View Source

Declaration

public static Task<IAuthSession> GetSessionAsync(this IRequest httpReq, bool reload = false, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<ServiceStack.Auth.IAuthSession>

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Boolean	reload
System.Threading.CancellationToken	token

GetSessionTimeToLive(ICacheClient, String)

View Source

Declaration

public static TimeSpan? GetSessionTimeToLive(this ICacheClient cache, string sessionId)

Returns

System.Nullable<System.TimeSpan>

Parameters

Type	Name
ServiceStack.Caching.ICacheClient	cache
System.String	sessionId

GetSessionTimeToLiveAsync(ICacheClientAsync, String, CancellationToken)

View Source

Declaration

public static async Task<TimeSpan?> GetSessionTimeToLiveAsync(this ICacheClientAsync cache, string sessionId, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<System.Nullable<System.TimeSpan>>

Parameters

Type	Name
ServiceStack.Caching.ICacheClientAsync	cache
System.String	sessionId
System.Threading.CancellationToken	token

GetSessionTimeToLive(IRequest)

View Source

Declaration

public static TimeSpan? GetSessionTimeToLive(this IRequest httpReq)

Returns

System.Nullable<System.TimeSpan>

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetSessionTimeToLiveAsync(IRequest, CancellationToken)

View Source

Declaration

public static Task<TimeSpan?> GetSessionTimeToLiveAsync(this IRequest httpReq, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<System.Nullable<System.TimeSpan>>

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Threading.CancellationToken	token

RunAction<TService, TRequest>(TService, TRequest, Func<TService, TRequest, Object>, IRequest)

View Source

Declaration

public static object RunAction<TService, TRequest>(this TService service, TRequest request, Func<TService, TRequest, object> invokeAction, IRequest requestContext = null)
    where TService : IService

Returns

System.Object

Parameters

Type	Name
<TService>	service
<TRequest>	request
System.Func<<TService>,<TRequest>,System.Object>	invokeAction
ServiceStack.Web.IRequest	requestContext

Type Parameters

• TService
• TRequest