Class BaseOAuthSettings
Common properties for the OauthXSettings
Inheritance
Namespace:Dapplo.HttpExtensions.OAuth
Assembly:Dapplo.HttpExtensions.dll
Syntax
public abstract class BaseOAuthSettings : ICodeReceiverSettings
Properties
| Improve this Doc View SourceAdditionalAttributes
Put anything in here which is needed for the OAuth implementation of this specific service but isn't generic, e.g. for Google there is a "scope"
Declaration
public IDictionary<string, string> AdditionalAttributes { get; set; }
Returns
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> |
AuthorizationUri
The autorization Uri where the values of this class will be "injected"
Example how this can be created:
new Uri("http://server").AppendSegments("auth").Query("client_id", "{ClientId}");
Declaration
public Uri AuthorizationUri { get; set; }
Returns
Type | Description |
---|---|
System.Uri |
AuthorizeMode
The AuthorizeMode for this OAuth settings
Declaration
public AuthorizeModes AuthorizeMode { get; set; }
Returns
Type | Description |
---|---|
AuthorizeModes |
ClientId
The OAuth client id / consumer key
Declaration
public string ClientId { get; set; }
Returns
Type | Description |
---|---|
System.String |
ClientSecret
The OAuth client/consumer secret
Declaration
public string ClientSecret { get; set; }
Returns
Type | Description |
---|---|
System.String |
CloudServiceName
Specify the name of the cloud service, so it can be used in window titles, logs etc
Declaration
public string CloudServiceName { get; set; }
Returns
Type | Description |
---|---|
System.String |
EmbeddedBrowserHeight
This can be used to specify the height of the embedded browser window
Declaration
public int EmbeddedBrowserHeight { get; set; }
Returns
Type | Description |
---|---|
System.Int32 |
EmbeddedBrowserWidth
This can be used to specify the width of the embedded browser window
Declaration
public int EmbeddedBrowserWidth { get; set; }
Returns
Type | Description |
---|---|
System.Int32 |
Lock
This makes sure than the OAuth request that needs to authenticate blocks all others until it's ready.
Declaration
public AsyncLock Lock { get; set; }
Returns
Type | Description |
---|---|
AsyncLock |
RedirectUrl
This is the redirect URL, in some implementations this is automatically set (LocalServerCodeReceiver) In some implementations this could be e.g. urn:ietf:wg:oauth:2.0:oob or urn:ietf:wg:oauth:2.0:oob:auto
Declaration
public string RedirectUrl { get; set; }
Returns
Type | Description |
---|---|
System.String |
State
The OAuth state, this is something that is passed to the server, is not processed but returned back to the client. e.g. a correlation ID Default this is filled with a new Guid
Declaration
public string State { get; set; }
Returns
Type | Description |
---|---|
System.String |
TokenUrl
The URL to get a (request) token
Declaration
public Uri TokenUrl { get; set; }
Returns
Type | Description |
---|---|
System.Uri |