C# Class RusticiSoftware.TinCanAPILibrary.TCAPI

The TCAPI object which handles the bulk of the logic and communication Note the read only properties, which must be assigned in the constructor are the asynchronous support variables. If a TCAPI with no AsyncSupport is created, batching statements for async launch will just populate the offlinestorage indefinitely, unless a manual call to Flush happens.

Inheritance: ITCAPI

Afficher le fichier Open project: RusticiSoftware/TinCanAPILibraryCSharp Class Usage Examples

Private Properties

Свойство	Type	Description
AsyncPostTimerElapsed	void
DetermineVersioning	TCAPIVersion
FlushAsync	void
GetWebHeaders	System.Net.WebHeaderCollection
PostConnectionFailed	void
PostFailed	void
PostSuccess	void
StoreStatements	void

Méthodes publiques

Méthode	Description
DeleteActivityProfile ( string activityId, string profileId ) : void	Deletes the profile for a given activity
DeleteActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId ) : void	Deletes the activity state
DeleteActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId, string registrationId ) : void	Deletes the activity state
DeleteActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string profileId ) : void	Deletes an actor profile
DeleteAllActivityProfile ( string activityId ) : void	Deletes all of the profiles associated with the activity
DeleteAllActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : void	Deletes all the actor profiles for a given actor
Dispose ( ) : void	Disposes the resources held by the TCAPI
Flush ( ) : void	Synchronously flushes the async queue, emptying the buffer completely. Any failed statements get pushed back into the buffer by default (and then throw their exception).
GetActivity ( string activityId ) : Activity	Gets an Activity
GetActivityProfile ( string activityId, string profileId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	Retrieves the ActivityProfile
GetActivityProfileIds ( string activityId ) : string[]	Gets all of the profile document keys for an activity
GetActivityProfileIds ( string activityId, NullableDateTime since ) : string[]	Gets all of the profile document keys for an activity
GetActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityState	Retrieves a specific activity state
GetActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId, string registrationId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityState	Retrieves a specific activity state
GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : string[]	Gets all the activity states for an activity
GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, NullableDateTime since ) : string[]	Gets all the activity states for an activity
GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string registrationId, NullableDateTime since ) : string[]	Gets all the activity states for an activity
GetActor ( RusticiSoftware.TinCanAPILibrary.Model.Actor partialActor ) : RusticiSoftware.TinCanAPILibrary.Model.Actor	Retreives a complete actor given a partial actor
GetActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string profileId ) : ActorProfile	Retrieves an Actor profile
GetActorProfileIds ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : string[]	Retrieves a list of all actor profile document keys
GetActorProfileIds ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, NullableDateTime since ) : string[]	Retrieves a list of all actor profile document keys
GetOAuthAuthorizationUrl ( string redirectUrl ) : string
GetStatement ( string statementId ) : RusticiSoftware.TinCanAPILibrary.Model.Statement	Retreives a statement with a given ID
GetStatements ( StatementQueryObject queryObject ) : StatementResult	Retreives all statements based matched by the query
GetStatements ( string moreUrl ) : StatementResult	Retreives the statements from a continue URL
SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile ) : void	Saves the activity profile
SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile previous ) : void	Saves the activity profile
SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, bool overwrite ) : void	Saves the activity profile
SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, bool overwrite, RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile previous ) : void	Saves the activity profile
SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState ) : void	Saves the activity state
SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState, RusticiSoftware.TinCanAPILibrary.Model.ActivityState previousState ) : void	Saves the activity state
SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState, bool overwrite ) : void	Saves the activity state
SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState, bool overwrite, RusticiSoftware.TinCanAPILibrary.Model.ActivityState previousState ) : void	Saves the activity state
SaveActorProfile ( ActorProfile actorProfile, ActorProfile previousProfile ) : void	Saves an actor profile
SaveActorProfile ( ActorProfile actorProfile, ActorProfile previousProfile, bool overwrite ) : void	Saves an actor profile
StoreStatement ( RusticiSoftware.TinCanAPILibrary.Model.Statement statement ) : void	Stores a single statement
StoreStatement ( RusticiSoftware.TinCanAPILibrary.Model.Statement statement, bool synchronous ) : void	Stores a single statement asynchronously
StoreStatements ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements ) : void	Stores multiple statements
StoreStatements ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements, bool synchronous ) : void	Stores multiple statements asynchronously
TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification ) : System	Constructs a TCAPI object with no asynchronous support.
TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage ) : System	Construct a TCAPI object with asynchronous support with a default post interval of 500ms and a default maxBatchSize of 10.
TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage, int statementPostInterval ) : System	Construct a TCAPI object with asynchronous support and a default maxBatchSize of 10.
TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage, int statementPostInterval, int maxBatchSize ) : System	Construct a TCAPI object with asynchronous support.
TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage, int statementPostInterval, int maxBatchSize, TCAPIVersion version ) : System
TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, TCAPIVersion version ) : System	Constructs a TCAPI Object, forcibly setting the version. Forcing the version is not recommended and should only be used if an issue with the LRS
UpdateOAuthTokenCredentials ( string temporaryCredentialsId, string verifierCode ) : RusticiSoftware.TinCanAPILibrary.Model.OAuthAuthentication
VoidStatements ( string statementIdsToVoid ) : void	Voids a series of statements using the administrator actor
VoidStatements ( string statementIdsToVoid, bool synchronous ) : void	Voids a series of statements using the administrator actor

Private Methods

Méthode	Description
AsyncPostTimerElapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void
DetermineVersioning ( Uri endPoint, IAuthenticationConfiguration authentication, TCAPIVersion version ) : TCAPIVersion	This method determines which version of the X-EXPERIENCE-API is being used by requesting a single statement and reading the versioning header. This allows proper serialization when communicating with the server.
FlushAsync ( ) : void	Runs multiple HTTPPostRequests serially and asynchronously.
GetWebHeaders ( Uri endPoint, IAuthenticationConfiguration authentication, TCAPIVersion version ) : WebHeaderCollection
PostConnectionFailed ( Exception e ) : void
PostFailed ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements, Exception e ) : void
PostSuccess ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements ) : void	This method is fired by the AsyncPostCallback every time FlushAsync succeeds.
StoreStatements ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements, AsyncPostCallback callback ) : void	Stores statements synchronously, must be called from a separate thread

Method Details

DeleteActivityProfile() public méthode

Deletes the profile for a given activity

public DeleteActivityProfile ( string activityId, string profileId ) : void
activityId	string	The activity ID
profileId	string	The profile document key
Résultat	void

DeleteActivityState() public méthode

Deletes the activity state

public DeleteActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId ) : void
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The associated actor
stateId	string	The state document key
Résultat	void

DeleteActivityState() public méthode

Deletes the activity state

public DeleteActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId, string registrationId ) : void
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The associated actor
stateId	string	The state document key
registrationId	string	Optional registration ID
Résultat	void

DeleteActorProfile() public méthode

Deletes an actor profile

public DeleteActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string profileId ) : void
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor that owns the profile
profileId	string	The profile document key
Résultat	void

DeleteAllActivityProfile() public méthode

Deletes all of the profiles associated with the activity

public DeleteAllActivityProfile ( string activityId ) : void
activityId	string	The activity ID
Résultat	void

DeleteAllActorProfile() public méthode

Deletes all the actor profiles for a given actor

public DeleteAllActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : void
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor to delete profiles from
Résultat	void

Dispose() public méthode

Disposes the resources held by the TCAPI

public Dispose ( ) : void
Résultat	void

Flush() public méthode

Synchronously flushes the async queue, emptying the buffer completely. Any failed statements get pushed back into the buffer by default (and then throw their exception).

public Flush ( ) : void
Résultat	void

GetActivity() public méthode

Gets an Activity

public GetActivity ( string activityId ) : Activity
activityId	string	The activity ID
Résultat	RusticiSoftware.TinCanAPILibrary.Model.Activity

GetActivityProfile() public méthode

Retrieves the ActivityProfile

public GetActivityProfile ( string activityId, string profileId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile
activityId	string	The activity ID
profileId	string	The profile document key
Résultat	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile

GetActivityProfileIds() public méthode

Gets all of the profile document keys for an activity

public GetActivityProfileIds ( string activityId ) : string[]
activityId	string	The activity ID
Résultat	string[]

GetActivityProfileIds() public méthode

Gets all of the profile document keys for an activity

public GetActivityProfileIds ( string activityId, NullableDateTime since ) : string[]
activityId	string	The activity ID
since	NullableDateTime	Optional start date parameter
Résultat	string[]

GetActivityState() public méthode

Retrieves a specific activity state

public GetActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityState
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor associated with the state
stateId	string	The state document id
Résultat	RusticiSoftware.TinCanAPILibrary.Model.ActivityState

GetActivityState() public méthode

Retrieves a specific activity state

public GetActivityState ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string stateId, string registrationId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityState
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor associated with the state
stateId	string	The state document id
registrationId	string	Optional registration ID
Résultat	RusticiSoftware.TinCanAPILibrary.Model.ActivityState

GetActivityStateIds() public méthode

Gets all the activity states for an activity

public GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : string[]
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor
Résultat	string[]

GetActivityStateIds() public méthode

Gets all the activity states for an activity

public GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, NullableDateTime since ) : string[]
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor
since	NullableDateTime	Exclusive start date
Résultat	string[]

GetActivityStateIds() public méthode

Gets all the activity states for an activity

public GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string registrationId, NullableDateTime since ) : string[]
activityId	string	The activity ID
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor
registrationId	string	The registration ID
since	NullableDateTime	Exclusive start date
Résultat	string[]

GetActor() public méthode

Retreives a complete actor given a partial actor

public GetActor ( RusticiSoftware.TinCanAPILibrary.Model.Actor partialActor ) : RusticiSoftware.TinCanAPILibrary.Model.Actor
partialActor	RusticiSoftware.TinCanAPILibrary.Model.Actor	An actor containing at least one inverse functional property
Résultat	RusticiSoftware.TinCanAPILibrary.Model.Actor

GetActorProfile() public méthode

Retrieves an Actor profile

public GetActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string profileId ) : ActorProfile
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor that owns the profile
profileId	string	The profile document key
Résultat	RusticiSoftware.TinCanAPILibrary.Model.ActorProfile

GetActorProfileIds() public méthode

Retrieves a list of all actor profile document keys

public GetActorProfileIds ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : string[]
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor that owns the document keys
Résultat	string[]

GetActorProfileIds() public méthode

Retrieves a list of all actor profile document keys

public GetActorProfileIds ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, NullableDateTime since ) : string[]
actor	RusticiSoftware.TinCanAPILibrary.Model.Actor	The actor that owns the document keys
since	NullableDateTime	Optional start date
Résultat	string[]

GetOAuthAuthorizationUrl() public méthode

public GetOAuthAuthorizationUrl ( string redirectUrl ) : string
redirectUrl	string
Résultat	string

GetStatement() public méthode

Retreives a statement with a given ID

public GetStatement ( string statementId ) : RusticiSoftware.TinCanAPILibrary.Model.Statement
statementId	string	Statement to retreive
Résultat	RusticiSoftware.TinCanAPILibrary.Model.Statement

GetStatements() public méthode

Retreives all statements based matched by the query

public GetStatements ( StatementQueryObject queryObject ) : StatementResult
queryObject	RusticiSoftware.TinCanAPILibrary.Model.StatementQueryObject	Object to create a statement query with
Résultat	RusticiSoftware.TinCanAPILibrary.Model.StatementResult

GetStatements() public méthode

Retreives the statements from a continue URL

public GetStatements ( string moreUrl ) : StatementResult
moreUrl	string
Résultat	RusticiSoftware.TinCanAPILibrary.Model.StatementResult

SaveActivityProfile() public méthode

Saves the activity profile

public SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile ) : void
profile	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	The activity profile to save
Résultat	void

SaveActivityProfile() public méthode

Saves the activity profile

public SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile previous ) : void
profile	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	The activity profile to save
previous	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	The last representation of the activity profile
Résultat	void

SaveActivityProfile() public méthode

Saves the activity profile

public SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, bool overwrite ) : void
profile	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	The activity profile to save
overwrite	bool
Résultat	void

SaveActivityProfile() public méthode

Saves the activity profile

public SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, bool overwrite, RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile previous ) : void
profile	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	The activity profile to save
overwrite	bool	Optional parameter to force overwrite
previous	RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile	The last representation of the activity profile
Résultat	void

SaveActivityState() public méthode

Saves the activity state

public SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState ) : void
activityState	RusticiSoftware.TinCanAPILibrary.Model.ActivityState	The activity state to save
Résultat	void

SaveActivityState() public méthode

Saves the activity state

public SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState, RusticiSoftware.TinCanAPILibrary.Model.ActivityState previousState ) : void
activityState	RusticiSoftware.TinCanAPILibrary.Model.ActivityState	The activity state to save
previousState	RusticiSoftware.TinCanAPILibrary.Model.ActivityState	Optional parameter for the last known state of the activity
Résultat	void

SaveActivityState() public méthode

Saves the activity state

public SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState, bool overwrite ) : void
activityState	RusticiSoftware.TinCanAPILibrary.Model.ActivityState	The activity state to save
overwrite	bool	Optional parameter to force overwrite
Résultat	void

SaveActivityState() public méthode

Saves the activity state

public SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState, bool overwrite, RusticiSoftware.TinCanAPILibrary.Model.ActivityState previousState ) : void
activityState	RusticiSoftware.TinCanAPILibrary.Model.ActivityState	The activity state to save
overwrite	bool	Optional parameter to force overwrite
previousState	RusticiSoftware.TinCanAPILibrary.Model.ActivityState	Optional parameter for the last known state of the activity
Résultat	void

SaveActorProfile() public méthode

Saves an actor profile

public SaveActorProfile ( ActorProfile actorProfile, ActorProfile previousProfile ) : void
actorProfile	RusticiSoftware.TinCanAPILibrary.Model.ActorProfile	The actor profile instance
previousProfile	RusticiSoftware.TinCanAPILibrary.Model.ActorProfile	The last instance of the actor profile
Résultat	void

SaveActorProfile() public méthode

Saves an actor profile

public SaveActorProfile ( ActorProfile actorProfile, ActorProfile previousProfile, bool overwrite ) : void
actorProfile	RusticiSoftware.TinCanAPILibrary.Model.ActorProfile	The actor profile instance
previousProfile	RusticiSoftware.TinCanAPILibrary.Model.ActorProfile	The last instance of the actor profile
overwrite	bool	Flag to force overwrite of the previous profile
Résultat	void

StoreStatement() public méthode

Stores a single statement

public StoreStatement ( RusticiSoftware.TinCanAPILibrary.Model.Statement statement ) : void
statement	RusticiSoftware.TinCanAPILibrary.Model.Statement	The statement to store
Résultat	void

StoreStatement() public méthode

Stores a single statement asynchronously

public StoreStatement ( RusticiSoftware.TinCanAPILibrary.Model.Statement statement, bool synchronous ) : void
statement	RusticiSoftware.TinCanAPILibrary.Model.Statement	The statement to store
synchronous	bool
Résultat	void

StoreStatements() public méthode

Stores multiple statements

public StoreStatements ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements ) : void
statements	RusticiSoftware.TinCanAPILibrary.Model.Statement	An array of statements to store
Résultat	void

StoreStatements() public méthode

Stores multiple statements asynchronously

public StoreStatements ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements, bool synchronous ) : void
statements	RusticiSoftware.TinCanAPILibrary.Model.Statement	An array of statements to store
synchronous	bool	When true, stores statements synchronously. When false, adds the statements to the queue.
Résultat	void

TCAPI() public méthode

Constructs a TCAPI object with no asynchronous support.

public TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification ) : System
endpoint	System.Uri	The endpoint for the TCAPI
authentification	IAuthenticationConfiguration	The authentification object
Résultat	System

TCAPI() public méthode

Construct a TCAPI object with asynchronous support with a default post interval of 500ms and a default maxBatchSize of 10.

public TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage ) : System
endpoint	System.Uri	The LRS endpoint
authentification	IAuthenticationConfiguration	Authentification object
tcapiCallback	ITCAPICallback	Asynchornous callback object
offlineStorage	IOfflineStorage	Offline Storage object
Résultat	System

TCAPI() public méthode

Construct a TCAPI object with asynchronous support and a default maxBatchSize of 10.

public TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage, int statementPostInterval ) : System
endpoint	System.Uri	The LRS endpoint
authentification	IAuthenticationConfiguration	Authentification object
tcapiCallback	ITCAPICallback	Asynchornous callback object
offlineStorage	IOfflineStorage	Offline Storage object
statementPostInterval	int	Interval for asynchronous operations to take place, in seconds
Résultat	System

TCAPI() public méthode

Construct a TCAPI object with asynchronous support.

public TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage, int statementPostInterval, int maxBatchSize ) : System
endpoint	System.Uri	The LRS endpoint
authentification	IAuthenticationConfiguration	Authentification object
tcapiCallback	ITCAPICallback	Asynchornous callback object
offlineStorage	IOfflineStorage	Offline Storage object
statementPostInterval	int	Interval for asynchronous operations to take place, in milliseconds
maxBatchSize	int
Résultat	System

TCAPI() public méthode

public TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, ITCAPICallback tcapiCallback, IOfflineStorage offlineStorage, int statementPostInterval, int maxBatchSize, TCAPIVersion version ) : System
endpoint	System.Uri
authentification	IAuthenticationConfiguration
tcapiCallback	ITCAPICallback
offlineStorage	IOfflineStorage
statementPostInterval	int
maxBatchSize	int
version	TCAPIVersion
Résultat	System

TCAPI() public méthode

Constructs a TCAPI Object, forcibly setting the version.

Forcing the version is not recommended and should only be used if an issue with the LRS

public TCAPI ( Uri endpoint, IAuthenticationConfiguration authentification, TCAPIVersion version ) : System
endpoint	System.Uri
authentification	IAuthenticationConfiguration
version	TCAPIVersion
Résultat	System

UpdateOAuthTokenCredentials() public méthode

public UpdateOAuthTokenCredentials ( string temporaryCredentialsId, string verifierCode ) : RusticiSoftware.TinCanAPILibrary.Model.OAuthAuthentication
temporaryCredentialsId	string
verifierCode	string
Résultat	RusticiSoftware.TinCanAPILibrary.Model.OAuthAuthentication

VoidStatements() public méthode

Voids a series of statements using the administrator actor

public VoidStatements ( string statementIdsToVoid ) : void
statementIdsToVoid	string	A list of statement IDs
Résultat	void

VoidStatements() public méthode

Voids a series of statements using the administrator actor

public VoidStatements ( string statementIdsToVoid, bool synchronous ) : void
statementIdsToVoid	string	A list of statement IDs
synchronous	bool
Résultat	void