forked from ServiceStack/ServiceStack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathServiceStack.xml
More file actions
5996 lines (5982 loc) · 330 KB
/
ServiceStack.xml
File metadata and controls
5996 lines (5982 loc) · 330 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>ServiceStack</name>
</assembly>
<members>
<member name="T:ServiceStack.RequestFilterAttribute">
<summary>
Base class to create request filter attributes only for specific HTTP methods (GET, POST...)
</summary>
</member>
<member name="M:ServiceStack.RequestFilterAttribute.#ctor(ServiceStack.ApplyTo)">
<summary>
Creates a new <see cref="T:ServiceStack.RequestFilterAttribute"/>
</summary>
<param name="applyTo">Defines when the filter should be executed</param>
</member>
<member name="M:ServiceStack.RequestFilterAttribute.Execute(ServiceStack.Web.IRequest,ServiceStack.Web.IResponse,System.Object)">
<summary>
This method is only executed if the HTTP method matches the <see cref="P:ServiceStack.RequestFilterAttribute.ApplyTo"/> property.
</summary>
<param name="req">The http request wrapper</param>
<param name="res">The http response wrapper</param>
<param name="requestDto">The request DTO</param>
</member>
<member name="M:ServiceStack.RequestFilterAttribute.Copy">
<summary>
Create a ShallowCopy of this instance.
</summary>
<returns></returns>
</member>
<member name="T:ServiceStack.EnsureHttpsAttribute">
<summary>
Redirect to the https:// version of this url if not already.
</summary>
</member>
<member name="P:ServiceStack.EnsureHttpsAttribute.SkipIfDebugMode">
<summary>
Don't redirect when in DebugMode
</summary>
</member>
<member name="P:ServiceStack.EnsureHttpsAttribute.SkipIfXForwardedFor">
<summary>
Don't redirect if the request was a forwarded request, e.g. from a Load Balancer
</summary>
</member>
<member name="T:ServiceStack.Messaging.IMessageHandler">
<summary>
Single threaded message handler that can process all messages
of a particular message type.
</summary>
</member>
<member name="M:ServiceStack.Messaging.IMessageHandler.Process(ServiceStack.Messaging.IMessageQueueClient)">
<summary>
Process all messages pending
</summary>
<param name="mqClient"></param>
</member>
<member name="M:ServiceStack.Messaging.IMessageHandler.ProcessQueue(ServiceStack.Messaging.IMessageQueueClient,System.String,System.Func{System.Boolean})">
<summary>
Process messages from a single queue.
</summary>
<param name="mqClient"></param>
<param name="queueName">The queue to process</param>
<param name="doNext">A predicate on whether to continue processing the next message if any</param>
<returns></returns>
</member>
<member name="M:ServiceStack.Messaging.IMessageHandler.GetStats">
<summary>
Get Current Stats for this Message Handler
</summary>
<returns></returns>
</member>
<member name="P:ServiceStack.Messaging.IMessageHandler.MessageType">
<summary>
The type of the message this handler processes
</summary>
</member>
<member name="T:ServiceStack.Messaging.IMessageHandlerFactory">
<summary>
Encapsulates creating a new message handler
</summary>
</member>
<member name="T:ServiceStack.Messaging.MessageHandler`1">
<summary>
Processes all messages in a Normal and Priority Queue.
Expects to be called in 1 thread. i.e. Non Thread-Safe.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.IRepository">
<summary>
A convenient repository base class you can inherit from to reduce the boilerplate
with accessing a managed IDbConnection
</summary>
</member>
<member name="T:ServiceStack.ILogic">
<summary>
A convenient base class for your injected service dependencies that reduces the boilerplate
with managed access to ServiceStack's built-in providers
</summary>
</member>
<member name="M:ServiceStack.HttpResult.SoftRedirect(System.String,System.Object)">
<summary>
Respond with a 'Soft redirect' so smart clients (e.g. ajax) have access to the response and
can decide whether or not they should redirect
</summary>
</member>
<member name="M:ServiceStack.HttpResult.TriggerEvent(System.Object,System.String,System.String)">
<summary>
Decorate the response with an additional client-side event to instruct participating
smart clients (e.g. ajax) with hints to transparently invoke client-side functionality
</summary>
</member>
<member name="M:ServiceStack.HttpResultExtensions.GetDto(System.Object)">
<summary>
Shortcut to get the ResponseDTO whether it's bare or inside a IHttpResult
</summary>
<param name="response"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.HttpResultExtensions.GetResponseDto(System.Object)">
<summary>
Alias of AsDto
</summary>
</member>
<member name="M:ServiceStack.HttpResultExtensions.GetDto``1(System.Object)">
<summary>
Shortcut to get the ResponseDTO whether it's bare or inside a IHttpResult
</summary>
<param name="response"></param>
<returns>TResponse if found; otherwise null</returns>
</member>
<member name="M:ServiceStack.HttpResultExtensions.GetResponseDto``1(System.Object)">
<summary>
Alias of AsDto
</summary>
</member>
<member name="M:ServiceStack.HttpResultExtensions.IsErrorResponse(System.Object)">
<summary>
Whether the response is an IHttpError or Exception
</summary>
</member>
<member name="M:ServiceStack.HttpResultExtensions.ExtractHttpRanges(System.String,System.Int64,System.Int64@,System.Int64@)">
<summary>
rangeHeader should be of the format "bytes=0-" or "bytes=0-12345" or "bytes=123-456"
</summary>
</member>
<member name="M:ServiceStack.HttpResultExtensions.AddHttpRangeResponseHeaders(ServiceStack.Web.IResponse,System.Int64,System.Int64,System.Int64)">
<summary>
Adds 206 PartialContent Status, Content-Range and Content-Length headers
</summary>
</member>
<member name="M:ServiceStack.HttpResultExtensions.WritePartialTo(System.IO.Stream,System.IO.Stream,System.Int64,System.Int64)">
<summary>
Writes partial range as specified by start-end, from fromStream to toStream.
</summary>
</member>
<member name="F:ServiceStack.RedisErrorLoggerFeature.UrnServiceErrorType">
<summary>
Service error logs are kept in 'urn:ServiceErrors:{ServiceName}'
</summary>
</member>
<member name="F:ServiceStack.RedisErrorLoggerFeature.CombinedServiceLogId">
<summary>
Combined service error logs are maintained in 'urn:ServiceErrors:All'
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.AtRestPath">
<summary>
RequestLogs service Route, default is /requestlogs
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.EnableSessionTracking">
<summary>
Turn On/Off Session Tracking
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.EnableRequestBodyTracking">
<summary>
Turn On/Off Logging of Raw Request Body, default is Off
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.EnableResponseTracking">
<summary>
Turn On/Off Tracking of Responses
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.EnableErrorTracking">
<summary>
Turn On/Off Tracking of Exceptions
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.Capacity">
<summary>
Size of InMemoryRollingRequestLogger circular buffer
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.RequiredRoles">
<summary>
Limit access to /requestlogs service to these roles
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.RequestLogger">
<summary>
Change the RequestLogger provider. Default is InMemoryRollingRequestLogger
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.ExcludeRequestDtoTypes">
<summary>
Don't log requests of these types. By default RequestLog's are excluded
</summary>
</member>
<member name="P:ServiceStack.RequestLogsFeature.HideRequestBodyForRequestDtoTypes">
<summary>
Don't log request bodys for services with sensitive information.
By default Auth and Registration requests are hidden.
</summary>
</member>
<member name="T:ServiceStack.Service">
<summary>
Generic + Useful IService base class
</summary>
</member>
<member name="M:ServiceStack.IServiceBase.ResolveService``1">
<summary>
Resolve an alternate Web Service from ServiceStack's IOC container.
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="F:ServiceStack.Service.session">
<summary>
Dynamic Session Bag
</summary>
</member>
<member name="M:ServiceStack.Service.SessionAs``1">
<summary>
Typed UserSession
</summary>
</member>
<member name="T:ServiceStack.AuthenticateAttribute">
<summary>
Indicates that the request dto, which is associated with this attribute,
requires authentication.
</summary>
</member>
<member name="P:ServiceStack.AuthenticateAttribute.Provider">
<summary>
Restrict authentication to a specific <see cref="T:ServiceStack.Auth.IAuthProvider"/>.
For example, if this attribute should only permit access
if the user is authenticated with <see cref="T:ServiceStack.Auth.BasicAuthProvider"/>,
you should set this property to <see cref="F:ServiceStack.Auth.BasicAuthProvider.Name"/>.
</summary>
</member>
<member name="P:ServiceStack.AuthenticateAttribute.HtmlRedirect">
<summary>
Redirect the client to a specific URL if authentication failed.
If this property is null, simply `401 Unauthorized` is returned.
</summary>
</member>
<member name="T:ServiceStack.AuthFeature">
<summary>
Enable the authentication feature and configure the AuthService.
</summary>
</member>
<member name="T:ServiceStack.Auth.ValidateFn">
<summary>
Inject logic into existing services by introspecting the request and injecting your own
validation logic. Exceptions thrown will have the same behaviour as if the service threw it.
If a non-null object is returned the request will short-circuit and return that response.
</summary>
<param name="service">The instance of the service</param>
<param name="httpMethod">GET,POST,PUT,DELETE</param>
<param name="requestDto"></param>
<returns>Response DTO; non-null will short-circuit execution and return that response</returns>
</member>
<member name="M:ServiceStack.Auth.AuthenticateService.Authenticate(ServiceStack.Authenticate)">
<summary>
Public API entry point to authenticate via code
</summary>
<param name="request"></param>
<returns>null; if already autenticated otherwise a populated instance of AuthResponse</returns>
</member>
<member name="M:ServiceStack.Auth.AuthenticateService.Authenticate(ServiceStack.Authenticate,System.String,ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthProvider)">
<summary>
The specified <paramref name="session"/> may change as a side-effect of this method. If
subsequent code relies on current <see cref="T:ServiceStack.Auth.IAuthSession"/> data be sure to reload
the session istance via <see cref="M:ServiceStack.ServiceExtensions.GetSession(ServiceStack.IServiceBase,System.Boolean)"/>.
</summary>
</member>
<member name="M:ServiceStack.Auth.IAuthProvider.Logout(ServiceStack.IServiceBase,ServiceStack.Authenticate)">
<summary>
Remove the Users Session
</summary>
<param name="service"></param>
<param name="request"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.IAuthProvider.Authenticate(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Authenticate)">
<summary>
The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally.
Overridable so you can provide your own Auth implementation.
</summary>
</member>
<member name="M:ServiceStack.Auth.IAuthProvider.IsAuthorized(ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthTokens,ServiceStack.Authenticate)">
<summary>
Determine if the current session is already authenticated with this AuthProvider
</summary>
</member>
<member name="M:ServiceStack.Auth.AuthProvider.FallbackConfig(System.String)">
<summary>
Allows specifying a global fallback config that if exists is formatted with the Provider as the first arg.
E.g. this appSetting with the TwitterAuthProvider:
oauth.CallbackUrl="http://localhost:11001/auth/{0}"
Would result in:
oauth.CallbackUrl="http://localhost:11001/auth/twitter"
</summary>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.AuthProvider.Logout(ServiceStack.IServiceBase,ServiceStack.Authenticate)">
<summary>
Remove the Users Session
</summary>
<param name="service"></param>
<param name="request"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.AuthProvider.SaveUserAuth(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthRepository,ServiceStack.Auth.IAuthTokens)">
<summary>
Saves the Auth Tokens for this request. Called in OnAuthenticated().
Overrideable, the default behaviour is to call IUserAuthRepository.CreateOrMergeAuthSession().
</summary>
</member>
<member name="T:ServiceStack.FluentValidation.AbstractValidator`1">
<summary>
Base class for entity validator classes.
</summary>
<typeparam name="T">The type of the object being validated</typeparam>
</member>
<member name="T:ServiceStack.FluentValidation.IValidator`1">
<summary>
Defines a validator for a particualr type.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:ServiceStack.FluentValidation.IValidator">
<summary>
Defines a validator for a particular type.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.IValidator.Validate(System.Object)">
<summary>
Validates the specified instance
</summary>
<param name="instance"></param>
<returns>A ValidationResult containing any validation failures</returns>
</member>
<member name="M:ServiceStack.FluentValidation.IValidator.Validate(ServiceStack.FluentValidation.ValidationContext)">
<summary>
Validates the specified instance.
</summary>
<param name="context">A ValidationContext</param>
<returns>A ValidationResult object containy any validation failures.</returns>
</member>
<member name="M:ServiceStack.FluentValidation.IValidator.CreateDescriptor">
<summary>
Creates a hook to access various meta data properties
</summary>
<returns>A IValidatorDescriptor object which contains methods to access metadata</returns>
</member>
<member name="M:ServiceStack.FluentValidation.IValidator.CanValidateInstancesOfType(System.Type)">
<summary>
Checks to see whether the validator can validate objects of the specified type
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.IValidator`1.Validate(`0)">
<summary>
Validates the specified instance.
</summary>
<param name="instance">The instance to validate</param>
<returns>A ValidationResult object containing any validation failures.</returns>
</member>
<member name="P:ServiceStack.FluentValidation.IValidator`1.CascadeMode">
<summary>
Sets the cascade mode for all rules within this validator.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.Validate(`0)">
<summary>
Validates the specified instance
</summary>
<param name="instance">The object to validate</param>
<returns>A ValidationResult object containing any validation failures</returns>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.Validate(ServiceStack.FluentValidation.ValidationContext{`0})">
<summary>
Validates the specified instance.
</summary>
<param name="context">Validation Context</param>
<returns>A ValidationResult object containing any validation failures.</returns>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.AddRule(ServiceStack.FluentValidation.IValidationRule)">
<summary>
Adds a rule to the current validator.
</summary>
<param name="rule"></param>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.CreateDescriptor">
<summary>
Creates a <see cref="T:ServiceStack.FluentValidation.IValidatorDescriptor"/> that can be used to obtain metadata about the current validator.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.RuleFor``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
<summary>
Defines a validation rule for a specify property.
</summary>
<example>
RuleFor(x => x.Surname)...
</example>
<typeparam name="TProperty">The type of property being validated</typeparam>
<param name="expression">The expression representing the property to validate</param>
<returns>an IRuleBuilder instance on which validators can be defined</returns>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.Custom(System.Func{`0,ServiceStack.FluentValidation.Results.ValidationFailure})">
<summary>
Defines a custom validation rule using a lambda expression.
If the validation rule fails, it should return a instance of a <see cref="T:ServiceStack.FluentValidation.Results.ValidationFailure">ValidationFailure</see>
If the validation rule succeeds, it should return null.
</summary>
<param name="customValidator">A lambda that executes custom validation rules.</param>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.Custom(System.Func{`0,ServiceStack.FluentValidation.ValidationContext{`0},ServiceStack.FluentValidation.Results.ValidationFailure})">
<summary>
Defines a custom validation rule using a lambda expression.
If the validation rule fails, it should return an instance of <see cref="T:ServiceStack.FluentValidation.Results.ValidationFailure">ValidationFailure</see>
If the validation rule succeeds, it should return null.
</summary>
<param name="customValidator">A lambda that executes custom validation rules</param>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.RuleSet(System.String,System.Action)">
<summary>
Defines a RuleSet that can be used to group together several validators.
</summary>
<param name="ruleSetName">The name of the ruleset.</param>
<param name="action">Action that encapsulates the rules in the ruleset.</param>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.RuleSet(ServiceStack.ApplyTo,System.Action)">
<summary>
Defines a RuleSet that can be used to provide specific validation rules for specific HTTP methods (GET, POST...)
</summary>
<param name="appliesTo">The HTTP methods where this rule set should be used.</param>
<param name="action">Action that encapuslates the rules in the ruleset.</param>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.When(System.Func{`0,System.Boolean},System.Action)">
<summary>
Defines a condition that applies to several rules
</summary>
<param name="predicate">The condition that should apply to multiple rules</param>
<param name="action">Action that encapsulates the rules.</param>
<returns></returns>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.Unless(System.Func{`0,System.Boolean},System.Action)">
<summary>
Defiles an inverse condition that applies to several rules
</summary>
<param name="predicate">The condition that should be applied to multiple rules</param>
<param name="action">Action that encapsulates the rules</param>
</member>
<member name="M:ServiceStack.FluentValidation.AbstractValidator`1.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection of validation rules.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
<filterpriority>1</filterpriority>
</member>
<member name="P:ServiceStack.FluentValidation.AbstractValidator`1.CascadeMode">
<summary>
Sets the cascade mode for all rules within this validator.
</summary>
</member>
<member name="T:ServiceStack.Auth.FacebookAuthProvider">
<summary>
Create a Facebook App at: https://developers.facebook.com/apps
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="M:ServiceStack.Auth.OAuthProvider.Authenticate(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Authenticate)">
<summary>
The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally.
Overridable so you can provide your own Auth implementation.
</summary>
<param name="authService"></param>
<param name="session"></param>
<param name="request"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.OAuthProvider.Init(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession@,ServiceStack.Authenticate)">
<summary>
Sets the CallbackUrl and session.ReferrerUrl if not set and initializes the session tokens for this AuthProvider
</summary>
<param name="authService"></param>
<param name="session"></param>
<param name="request"> </param>
<returns></returns>
</member>
<member name="M:ServiceStack.Auth.AuthHttpGateway.DownloadYammerUserInfo(System.String)">
<summary>
Download Yammer User Info given its ID.
</summary>
<param name="yammerUserId">
The Yammer User ID.
</param>
<returns>
The User info in JSON format.
</returns>
<remarks>
<para>
Yammer provides a method to retrieve current user information via
"https://www.yammer.com/api/v1/users/current.json".
</para>
<para>
However, to ensure consistency with the rest of the Auth codebase,
the explicit URL will be used, where [:id] denotes the User ID:
"https://www.yammer.com/api/v1/users/[:id].json"
</para>
<para>
Refer to: https://developer.yammer.com/restapi/ for full documentation.
</para>
</remarks>
</member>
<member name="T:ServiceStack.Auth.InMemoryAuthRepository">
<summary>
Thread-safe In memory UserAuth data store so it can be used without a dependency on Redis.
</summary>
</member>
<member name="M:ServiceStack.Auth.IRequiresSchema.InitSchema">
<summary>
Creates the required missing tables or DB schema
</summary>
</member>
<member name="M:ServiceStack.Auth.RegisterService`1.Post(ServiceStack.Register)">
<summary>
Create new Registration
</summary>
</member>
<member name="M:ServiceStack.Auth.RegisterService`1.UpdateUserAuth(ServiceStack.Register)">
<summary>
Logic to update UserAuth from Registration info, not enabled on OnPut because of security.
</summary>
</member>
<member name="T:ServiceStack.Auth.SaltedHash">
<summary>
Thank you Martijn
http://www.dijksterhuis.org/creating-salted-hash-values-in-c/
</summary>
</member>
<member name="T:ServiceStack.Auth.TwitterAuthProvider">
<summary>
Create an app at https://dev.twitter.com/apps to get your ConsumerKey and ConsumerSecret for your app.
The Callback URL for your app should match the CallbackUrl provided.
</summary>
</member>
<member name="M:ServiceStack.Auth.UserAuthExtensions.InitSchema(ServiceStack.Auth.IUserAuthRepository)">
<summary>
Creates the required missing tables or DB schema
</summary>
</member>
<member name="T:ServiceStack.Auth.YammerAuthProvider">
<summary>
The ServiceStack Yammer OAuth provider.
</summary>
<remarks>
<para>
This provider is loosely based on the existing ServiceStack's Facebook OAuth provider.
</para>
<para>
For the full info on Yammer's OAuth2 authentication flow, refer to:
https://developer.yammer.com/authentication/#a-oauth2
</para>
<para>
Note: Add these to your application / web config settings under appSettings and replace
values as appropriate.
<![CDATA[
<!-- ServiceStack Yammer OAuth config -->
<add key="oauth.yammer.ClientId" value=""/>
<add key="oauth.yammer.ClientSecret" value=""/>
<add key="oauth.yammer.AccessTokenUrl" value="https://www.yammer.com/oauth2/access_token.json"/>
<add key="oauth.yammer.CallbackUrl" value="~/"/>
<add key="oauth.yammer.PreAuthUrl" value="https://www.yammer.com/dialog/oauth"/>
<add key="oauth.yammer.Realm" value="https://www.yammer.com"/>
<add key="oauth.yammer.RedirectUrl" value="~/auth/yammer"/>
]]>
</para>
</remarks>
</member>
<member name="F:ServiceStack.Auth.YammerAuthProvider.Name">
<summary>
The OAuth provider name / identifier.
</summary>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.#ctor(ServiceStack.Configuration.IAppSettings)">
<summary>
Initializes a new instance of the <see cref="T:ServiceStack.Auth.YammerAuthProvider"/> class.
</summary>
<param name="appSettings">
The application settings (in web.config).
</param>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.Authenticate(ServiceStack.IServiceBase,ServiceStack.Auth.IAuthSession,ServiceStack.Authenticate)">
<summary>
Authenticate against Yammer OAuth endpoint.
</summary>
<param name="authService">
The auth service.
</param>
<param name="session">
The session.
</param>
<param name="request">
The request.
</param>
<returns>
The <see cref="T:System.Object"/>.
</returns>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.LoadUserAuthInfo(ServiceStack.AuthUserSession,ServiceStack.Auth.IAuthTokens,System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Load the UserAuth info into the session.
</summary>
<param name="userSession">
The User session.
</param>
<param name="tokens">
The OAuth tokens.
</param>
<param name="authInfo">
The auth info.
</param>
</member>
<member name="M:ServiceStack.Auth.YammerAuthProvider.LoadUserOAuthProvider(ServiceStack.Auth.IAuthSession,ServiceStack.Auth.IAuthTokens)">
<summary>
Load the UserOAuth info into the session.
</summary>
<param name="authSession">
The auth session.
</param>
<param name="tokens">
The OAuth tokens.
</param>
</member>
<member name="P:ServiceStack.Auth.YammerAuthProvider.ClientId">
<summary>
Gets or sets the Yammer OAuth client id.
</summary>
</member>
<member name="P:ServiceStack.Auth.YammerAuthProvider.ClientSecret">
<summary>
Gets or sets the Yammer OAuth client secret.
</summary>
</member>
<member name="P:ServiceStack.Auth.YammerAuthProvider.PreAuthUrl">
<summary>
Gets or sets the Yammer OAuth pre-auth url.
</summary>
</member>
<member name="T:ServiceStack.Auth.EmailAddresses">
<summary>
The Yammer User's email addresses.
</summary>
</member>
<member name="P:ServiceStack.Auth.EmailAddresses.Type">
<summary>
Gets or sets the email address type (e.g. primary).
</summary>
</member>
<member name="P:ServiceStack.Auth.EmailAddresses.Address">
<summary>
Gets or sets the email address.
</summary>
</member>
<member name="M:ServiceStack.CacheClientExtensions.RemoveByPattern(ServiceStack.Caching.ICacheClient,System.String)">
<summary>
Removes items from cache that have keys matching the specified wildcard pattern
</summary>
<param name="cacheClient">Cache client</param>
<param name="pattern">The wildcard, where "*" means any sequence of characters and "?" means any single character.</param>
</member>
<member name="M:ServiceStack.CacheClientExtensions.RemoveByRegex(ServiceStack.Caching.ICacheClient,System.String)">
<summary>
Removes items from the cache based on the specified regular expression pattern
</summary>
<param name="cacheClient">Cache client</param>
<param name="regex">Regular expression pattern to search cache keys</param>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheAdd(System.String,System.Object)">
<summary>
Add value with specified key to the cache, and set the cache entry to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheAdd(System.String,System.Object,System.DateTime)">
<summary>
Stores The value with key only if such key doesn't exist at the server yet.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheSet(System.String,System.Object)">
<summary>
Adds or replaces the value with key, and sets the cache entry to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheSet(System.String,System.Object,System.DateTime)">
<summary>
Adds or replaces the value with key.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheSet(System.String,System.Object,System.DateTime,System.Nullable{System.Int64})">
<summary>
Adds or replaces the value with key.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheReplace(System.String,System.Object)">
<summary>
Replace the value with specified key if it exists, and set the cache entry to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheReplace(System.String,System.Object,System.DateTime)">
<summary>
Replace the value with specified key if it exists.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Add``1(System.String,``0)">
<summary>
Add the value with key to the cache, set to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Set``1(System.String,``0)">
<summary>
Add or replace the value with key to the cache, set to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Replace``1(System.String,``0)">
<summary>
Replace the value with key in the cache, set to never expire.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Add``1(System.String,``0,System.DateTime)">
<summary>
Add the value with key to the cache, set to expire at specified DateTime.
</summary>
<remarks>This method examines the DateTimeKind of expiresAt to determine if conversion to
universal time is needed. The version of Add that takes a TimeSpan expiration is faster
than using this method with a DateTime of Kind other than Utc, and is not affected by
ambiguous local time during daylight savings/standard time transition.</remarks>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Set``1(System.String,``0,System.DateTime)">
<summary>
Add or replace the value with key to the cache, set to expire at specified DateTime.
</summary>
<remarks>This method examines the DateTimeKind of expiresAt to determine if conversion to
universal time is needed. The version of Set that takes a TimeSpan expiration is faster
than using this method with a DateTime of Kind other than Utc, and is not affected by
ambiguous local time during daylight savings/standard time transition.</remarks>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Replace``1(System.String,``0,System.DateTime)">
<summary>
Replace the value with key in the cache, set to expire at specified DateTime.
</summary>
<remarks>This method examines the DateTimeKind of expiresAt to determine if conversion to
universal time is needed. The version of Replace that takes a TimeSpan expiration is faster
than using this method with a DateTime of Kind other than Utc, and is not affected by
ambiguous local time during daylight savings/standard time transition.</remarks>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Add``1(System.String,``0,System.TimeSpan)">
<summary>
Add the value with key to the cache, set to expire after specified TimeSpan.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Set``1(System.String,``0,System.TimeSpan)">
<summary>
Add or replace the value with key to the cache, set to expire after specified TimeSpan.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.Replace``1(System.String,``0,System.TimeSpan)">
<summary>
Replace the value with key in the cache, set to expire after specified TimeSpan.
</summary>
</member>
<member name="M:ServiceStack.Caching.MemoryCacheClient.CacheEntry.#ctor(System.Object,System.DateTime)">
<summary>
Create new instance of CacheEntry.
</summary>
</member>
<member name="P:ServiceStack.Caching.MemoryCacheClient.CacheEntry.ExpiresAt">
<summary>UTC time at which CacheEntry expires.</summary>
</member>
<member name="F:ServiceStack.Configuration.Config.DefaultNamespace">
<summary>
Would've preferred to use [assembly: ContractNamespace] attribute but it is not supported in Mono
</summary>
</member>
<member name="T:ServiceStack.Configuration.AppSettings">
<summary>
More familiar name for the new crowd.
</summary>
</member>
<member name="M:ServiceStack.Configuration.AppSettings.#ctor(System.String)">
<summary>
The tier lets you specify a retrieving a setting with the tier prefix first before falling back to the original key.
E.g a tier of 'Live' looks for 'Live.{Key}' or if not found falls back to '{Key}'.
</summary>
</member>
<member name="M:ServiceStack.Configuration.AppSettings.GetString(System.String)">
<summary>
Returns string if exists, otherwise null
</summary>
<param name="name"></param>
<returns></returns>
</member>
<member name="M:ServiceStack.Configuration.ISettings.Get(System.String)">
<summary>
Provides a common interface for Settings providers such as
ConfigurationManager or Azure's RoleEnvironment. The only
requirement is that if the implementation cannot find the
specified key, the return value must be null
</summary>
<param name="key">The key for the setting</param>
<returns>The string value of the specified key, or null if the key
was invalid</returns>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetNullableAppSetting(System.String)">
<summary>
Gets the nullable app setting.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetAppSetting(System.String)">
<summary>
Gets the app setting.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.ConfigSectionExists(System.String)">
<summary>
Determines wheter the Config section identified by the sectionName exists.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetAppSetting(System.String,System.String)">
<summary>
Returns AppSetting[key] if exists otherwise defaultValue
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetAppSetting``1(System.String,``0)">
<summary>
Returns AppSetting[key] if exists otherwise defaultValue, for non-string values
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetConnectionStringSetting(System.String)">
<summary>
Gets the connection string setting.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetConnectionString(System.String)">
<summary>
Gets the connection string.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetListFromAppSetting(System.String)">
<summary>
Gets the list from app setting.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetDictionaryFromAppSetting(System.String)">
<summary>
Gets the dictionary from app setting.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetParseMethod(System.Type)">
<summary>
Get the static Parse(string) method on the type supplied
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.GetConstructorInfo(System.Type)">
<summary>
Gets the constructor info for T(string) if exists.
</summary>
</member>
<member name="M:ServiceStack.Configuration.ConfigUtils.ParseTextValue``1(System.String)">
<summary>
Returns the value returned by the 'T.Parse(string)' method if exists otherwise 'new T(string)'.
e.g. if T was a TimeSpan it will return TimeSpan.Parse(textValue).
If there is no Parse Method it will attempt to create a new instance of the destined type
</summary>
</member>
<member name="T:ServiceStack.CorsFeature">
<summary>
Plugin adds support for Cross-origin resource sharing (CORS, see http://www.w3.org/TR/access-control/).
CORS allows to access resources from different domain which usually forbidden by origin policy.
</summary>
</member>
<member name="M:ServiceStack.CorsFeature.#ctor(System.String,System.String,System.String,System.Boolean)">
<summary>
Represents a default constructor with Allow Origin equals to "*", Allowed GET, POST, PUT, DELETE, OPTIONS request and allowed "Content-Type" header.
</summary>
</member>
<member name="T:ServiceStack.EnableCorsAttribute">
<summary>
Attribute marks that specific response class has support for Cross-origin resource sharing (CORS, see http://www.w3.org/TR/access-control/). CORS allows to access resources from different domain which usually forbidden by origin policy.
</summary>
</member>
<member name="M:ServiceStack.EnableCorsAttribute.#ctor(System.String,System.String,System.String,System.Boolean)">
<summary>
Represents a default constructor with Allow Origin equals to "*", Allowed GET, POST, PUT, DELETE, OPTIONS request and allowed "Content-Type" header.
</summary>
</member>
<member name="T:ServiceStack.DefaultViewAttribute">
<summary>
Change the default HTML view or template used for the HTML response of this service
</summary>
</member>
<member name="T:ServiceStack.FluentValidation.AssemblyScanner">
<summary>
Class that can be used to find all the validators from a collection of types.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AssemblyScanner.#ctor(System.Collections.Generic.IEnumerable{System.Type})">
<summary>
Creates a scanner that works on a sequence of types.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AssemblyScanner.FindValidatorsInAssembly(System.Reflection.Assembly)">
<summary>
Finds all the validators in the specified assembly.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AssemblyScanner.FindValidatorsInAssemblyContaining``1">
<summary>
Finds all the validators in the assembly containing the specified type.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AssemblyScanner.ForEach(System.Action{ServiceStack.FluentValidation.AssemblyScanner.AssemblyScanResult})">
<summary>
Performs the specified action to all of the assembly scan results.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AssemblyScanner.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
<filterpriority>1</filterpriority>
</member>
<member name="T:ServiceStack.FluentValidation.AssemblyScanner.AssemblyScanResult">
<summary>
Result of performing a scan.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.AssemblyScanner.AssemblyScanResult.#ctor(System.Type,System.Type)">
<summary>
Creates an instance of an AssemblyScanResult.
</summary>
</member>
<member name="P:ServiceStack.FluentValidation.AssemblyScanner.AssemblyScanResult.InterfaceType">
<summary>
Validator interface type, eg IValidator<Foo>
</summary>
</member>
<member name="P:ServiceStack.FluentValidation.AssemblyScanner.AssemblyScanResult.ValidatorType">
<summary>
Concrete type that implements the InterfaceType, eg FooValidator.
</summary>
</member>
<member name="T:ServiceStack.FluentValidation.Attributes.AttributedValidatorFactory">
<summary>
Implementation of IValidatorFactory that looks for ValidatorAttribute instances on the specified type in order to provide the validator instance.
</summary>
</member>
<member name="T:ServiceStack.FluentValidation.IValidatorFactory">
<summary>
Gets validators for a particular type.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.IValidatorFactory.GetValidator``1">
<summary>
Gets the validator for the specified type.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.IValidatorFactory.GetValidator(System.Type)">
<summary>
Gets the validator for the specified type.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.Attributes.AttributedValidatorFactory.GetValidator``1">
<summary>
Gets a validator for the appropriate type.
</summary>
</member>
<member name="M:ServiceStack.FluentValidation.Attributes.AttributedValidatorFactory.GetValidator(System.Type)">