Свойство | Тип | Описание | |
---|---|---|---|
AsyncPostTimerElapsed | void | ||
DetermineVersioning | TCAPIVersion | ||
FlushAsync | void | ||
GetWebHeaders | |||
PostConnectionFailed | void | ||
PostFailed | void | ||
PostSuccess | void | ||
StoreStatements | void |
Метод | Описание | |
---|---|---|
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 ) : |
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 ) : |
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 ( |
Retreives all statements based matched by the query
|
|
GetStatements ( string moreUrl ) : |
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 ( |
Saves an actor profile
|
|
SaveActorProfile ( |
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 ( |
Constructs a TCAPI object with no asynchronous support.
|
|
TCAPI ( |
Construct a TCAPI object with asynchronous support with a default post interval of 500ms and a default maxBatchSize of 10.
|
|
TCAPI ( |
Construct a TCAPI object with asynchronous support and a default maxBatchSize of 10.
|
|
TCAPI ( |
Construct a TCAPI object with asynchronous support.
|
|
TCAPI ( |
||
TCAPI ( |
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
|
Метод | Описание | |
---|---|---|
AsyncPostTimerElapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void | ||
DetermineVersioning ( |
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 ( |
||
PostConnectionFailed ( |
||
PostFailed ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements, |
||
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
|
public DeleteActivityProfile ( string activityId, string profileId ) : void | ||
activityId | string | The activity ID |
profileId | string | The profile document key |
Результат | void |
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 |
Результат | void |
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 |
Результат | void |
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 |
Результат | void |
public DeleteAllActivityProfile ( string activityId ) : void | ||
activityId | string | The activity ID |
Результат | void |
public DeleteAllActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : void | ||
actor | RusticiSoftware.TinCanAPILibrary.Model.Actor | The actor to delete profiles from |
Результат | void |
public GetActivity ( string activityId ) : |
||
activityId | string | The activity ID |
Результат |
public GetActivityProfile ( string activityId, string profileId ) : RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile | ||
activityId | string | The activity ID |
profileId | string | The profile document key |
Результат | RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile |
public GetActivityProfileIds ( string activityId ) : string[] | ||
activityId | string | The activity ID |
Результат | string[] |
public GetActivityProfileIds ( string activityId, NullableDateTime since ) : string[] | ||
activityId | string | The activity ID |
since | NullableDateTime | Optional start date parameter |
Результат | string[] |
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 |
Результат | RusticiSoftware.TinCanAPILibrary.Model.ActivityState |
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 |
Результат | RusticiSoftware.TinCanAPILibrary.Model.ActivityState |
public GetActivityStateIds ( string activityId, RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : string[] | ||
activityId | string | The activity ID |
actor | RusticiSoftware.TinCanAPILibrary.Model.Actor | The actor |
Результат | string[] |
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 |
Результат | string[] |
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 |
Результат | string[] |
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 |
Результат | RusticiSoftware.TinCanAPILibrary.Model.Actor |
public GetActorProfile ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor, string profileId ) : |
||
actor | RusticiSoftware.TinCanAPILibrary.Model.Actor | The actor that owns the profile |
profileId | string | The profile document key |
Результат |
public GetActorProfileIds ( RusticiSoftware.TinCanAPILibrary.Model.Actor actor ) : string[] | ||
actor | RusticiSoftware.TinCanAPILibrary.Model.Actor | The actor that owns the document keys |
Результат | string[] |
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 |
Результат | string[] |
public GetOAuthAuthorizationUrl ( string redirectUrl ) : string | ||
redirectUrl | string | |
Результат | string |
public GetStatement ( string statementId ) : RusticiSoftware.TinCanAPILibrary.Model.Statement | ||
statementId | string | Statement to retreive |
Результат | RusticiSoftware.TinCanAPILibrary.Model.Statement |
public GetStatements ( |
||
queryObject | Object to create a statement query with | |
Результат |
public GetStatements ( string moreUrl ) : |
||
moreUrl | string | |
Результат |
public SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile ) : void | ||
profile | RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile | The activity profile to save |
Результат | void |
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 |
Результат | void |
public SaveActivityProfile ( RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile profile, bool overwrite ) : void | ||
profile | RusticiSoftware.TinCanAPILibrary.Model.ActivityProfile | The activity profile to save |
overwrite | bool | |
Результат | void |
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 |
Результат | void |
public SaveActivityState ( RusticiSoftware.TinCanAPILibrary.Model.ActivityState activityState ) : void | ||
activityState | RusticiSoftware.TinCanAPILibrary.Model.ActivityState | The activity state to save |
Результат | void |
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 |
Результат | void |
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 |
Результат | void |
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 |
Результат | void |
public SaveActorProfile ( |
||
actorProfile | The actor profile instance | |
previousProfile | The last instance of the actor profile | |
Результат | void |
public SaveActorProfile ( |
||
actorProfile | The actor profile instance | |
previousProfile | The last instance of the actor profile | |
overwrite | bool | Flag to force overwrite of the previous profile |
Результат | void |
public StoreStatement ( RusticiSoftware.TinCanAPILibrary.Model.Statement statement ) : void | ||
statement | RusticiSoftware.TinCanAPILibrary.Model.Statement | The statement to store |
Результат | void |
public StoreStatement ( RusticiSoftware.TinCanAPILibrary.Model.Statement statement, bool synchronous ) : void | ||
statement | RusticiSoftware.TinCanAPILibrary.Model.Statement | The statement to store |
synchronous | bool | |
Результат | void |
public StoreStatements ( RusticiSoftware.TinCanAPILibrary.Model.Statement statements ) : void | ||
statements | RusticiSoftware.TinCanAPILibrary.Model.Statement | An array of statements to store |
Результат | void |
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. |
Результат | void |
public TCAPI ( |
||
endpoint | The endpoint for the TCAPI | |
authentification | IAuthenticationConfiguration | The authentification object |
Результат | System |
public TCAPI ( |
||
endpoint | The LRS endpoint | |
authentification | IAuthenticationConfiguration | Authentification object |
tcapiCallback | ITCAPICallback | Asynchornous callback object |
offlineStorage | IOfflineStorage | Offline Storage object |
Результат | System |
public TCAPI ( |
||
endpoint | 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 |
Результат | System |
public TCAPI ( |
||
endpoint | 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 | |
Результат | System |
public TCAPI ( |
||
endpoint | ||
authentification | IAuthenticationConfiguration | |
tcapiCallback | ITCAPICallback | |
offlineStorage | IOfflineStorage | |
statementPostInterval | int | |
maxBatchSize | int | |
version | TCAPIVersion | |
Результат | System |
public TCAPI ( |
||
endpoint | ||
authentification | IAuthenticationConfiguration | |
version | TCAPIVersion | |
Результат | System |
public UpdateOAuthTokenCredentials ( string temporaryCredentialsId, string verifierCode ) : RusticiSoftware.TinCanAPILibrary.Model.OAuthAuthentication | ||
temporaryCredentialsId | string | |
verifierCode | string | |
Результат | RusticiSoftware.TinCanAPILibrary.Model.OAuthAuthentication |
public VoidStatements ( string statementIdsToVoid ) : void | ||
statementIdsToVoid | string | A list of statement IDs |
Результат | void |
public VoidStatements ( string statementIdsToVoid, bool synchronous ) : void | ||
statementIdsToVoid | string | A list of statement IDs |
synchronous | bool | |
Результат | void |