C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.Authentication.OauthAccessToken Class Reference

An AccessToken storing OAuth authentication information for requests made to the server. More...

Public Member Functions

 OauthAccessToken ()
 Construct a new unauthorized AccessToken. More...
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. More...

 
override string ToString ()
 Returns the representation of this access token that could be placed in an "Authorization" header. More...
 

Public Attributes

string AuthorizationMethod => "bearer"
 The Authorization Method included in the Authorization header. More...
 
override string collection_name => CLASS_COLLECTION_NAME
 
string Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. More...
 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "access_tokens"
 The collection endpoint at which resources of this type reside on the server. More...
 

Protected Member Functions

virtual void AfterMembersCloned (APIType originalResource)
 Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned. More...
 

Properties

string access_token [get, set]
 The AccessToken identifier. More...
 
string authorize_url [get, set]
 The URL the user can navigate to authenticate with this server. More...
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. More...
 
AccessTokenStatus status [get, set]
 The AccessToken's current AccessTokenStatus (unauthorized / valid). More...
 

Detailed Description

An AccessToken storing OAuth authentication information for requests made to the server.

Definition at line 9 of file OauthAccessToken.cs.

Inheritance diagram for AnalyzeRe.Authentication.OauthAccessToken:
AnalyzeRe.APIResource AnalyzeRe.Authentication.IAccessToken AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint

Constructor & Destructor Documentation

AnalyzeRe.Authentication.OauthAccessToken.OauthAccessToken ( )
inline

Construct a new unauthorized AccessToken.

Definition at line 49 of file OauthAccessToken.cs.

Member Function Documentation

virtual void AnalyzeRe.APIType.AfterMembersCloned ( APIType  originalResource)
inlineprotectedvirtualinherited

Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.

Overriding implementations should be sure to invoke base.AfterMembersCloned().

A sane question for a code reviewer to ask might be: "Why not avoid copying those members in the first place?" The answer is that there is no framework-supported method of excluding members from a MemberwiseClone. The only officially supported solution is to not use the object.MemberwiseClone method at all and instead have each class implement it's own Copy method. In our case, most objects have no need to specialize their copy implementation (even though they could - the ShallowCopy<T> method is marked virtual). It's simpler to simply "correct" any special-case members after the fact, and requires less error-prone code than if the code were responsible for ensuring no members were missed in a copy. It's also faster than any reflection-based approach, even though such an approach could benefit from custom attributes meant to exclude certain members from copying.

Reimplemented in AnalyzeRe.APIResourceView.BaseAPIResourceView, AnalyzeRe.Optimization.OptimizationView, AnalyzeRe.Optimization.Candidate, AnalyzeRe.StaticSimulation, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.APITypes.APIResource_WithDataEndpoint.

Definition at line 37 of file APIType.cs.

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

If this object contains any members that reference the current object (this), the class should override this method to avoid cloning a reference to the old class.

Implements AnalyzeRe.IAPIType.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

override string AnalyzeRe.Authentication.OauthAccessToken.ToString ( )

Returns the representation of this access token that could be placed in an "Authorization" header.

Returns
The representation of this access token that could be placed in an "Authorization" header.

Member Data Documentation

string AnalyzeRe.Authentication.OauthAccessToken.AuthorizationMethod => "bearer"

The Authorization Method included in the Authorization header.

Definition at line 24 of file OauthAccessToken.cs.

readonly string AnalyzeRe.Authentication.OauthAccessToken.CLASS_COLLECTION_NAME = "access_tokens"
static

The collection endpoint at which resources of this type reside on the server.

Definition at line 15 of file OauthAccessToken.cs.

override string AnalyzeRe.Authentication.OauthAccessToken.collection_name => CLASS_COLLECTION_NAME

Definition at line 17 of file OauthAccessToken.cs.

string AnalyzeRe.APIResource.Path => API.GetResourcePath(this)
inherited

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Definition at line 27 of file APIResource.cs.

Property Documentation

string AnalyzeRe.Authentication.OauthAccessToken.access_token
getset

The AccessToken identifier.

Definition at line 31 of file OauthAccessToken.cs.

string AnalyzeRe.Authentication.OauthAccessToken.authorize_url
getset

The URL the user can navigate to authenticate with this server.

Definition at line 44 of file OauthAccessToken.cs.

string AnalyzeRe.APIResource.id
getsetinherited

The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Definition at line 16 of file APIResource.cs.

AccessTokenStatus AnalyzeRe.Authentication.OauthAccessToken.status
getset

The AccessToken's current AccessTokenStatus (unauthorized / valid).

Definition at line 39 of file OauthAccessToken.cs.


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