Package com.mypurecloud.sdk.v2.api

Class LearningApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.LearningApiAsync

public class LearningApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
LearningApiAsync()
LearningApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deleteLearningAssignmentAsync(DeleteLearningAssignmentRequest request, AsyncApiCallback<Void> callback)	Delete a learning assignment
Future<ApiResponse<Void>>	deleteLearningAssignmentAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a learning assignment
Future<Void>	deleteLearningModuleAsync(DeleteLearningModuleRequest request, AsyncApiCallback<Void> callback)	Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module
Future<ApiResponse<Void>>	deleteLearningModuleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module
Future<LearningAssignment>	getLearningAssignmentAsync(GetLearningAssignmentRequest request, AsyncApiCallback<LearningAssignment> callback)	Get Learning Assignment Permission not required if you are the assigned user of the learning assignment
Future<ApiResponse<LearningAssignment>>	getLearningAssignmentAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Get Learning Assignment Permission not required if you are the assigned user of the learning assignment
Future<LearningAssignmentsDomainEntity>	getLearningAssignmentsAsync(GetLearningAssignmentsRequest request, AsyncApiCallback<LearningAssignmentsDomainEntity> callback)	List of Learning module Assignments Either moduleId or user value is required
Future<ApiResponse<LearningAssignmentsDomainEntity>>	getLearningAssignmentsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningAssignmentsDomainEntity>> callback)	List of Learning module Assignments Either moduleId or user value is required
Future<LearningAssignmentsDomainEntity>	getLearningAssignmentsMeAsync(GetLearningAssignmentsMeRequest request, AsyncApiCallback<LearningAssignmentsDomainEntity> callback)	List of Learning Assignments assigned to current user
Future<ApiResponse<LearningAssignmentsDomainEntity>>	getLearningAssignmentsMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningAssignmentsDomainEntity>> callback)	List of Learning Assignments assigned to current user
Future<LearningAssignmentStep>	getLearningAssignmentStepAsync(GetLearningAssignmentStepRequest request, AsyncApiCallback<LearningAssignmentStep> callback)	Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
Future<ApiResponse<LearningAssignmentStep>>	getLearningAssignmentStepAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningAssignmentStep>> callback)	Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
Future<LearningModule>	getLearningModuleAsync(GetLearningModuleRequest request, AsyncApiCallback<LearningModule> callback)	Get a learning module
Future<ApiResponse<LearningModule>>	getLearningModuleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModule>> callback)	Get a learning module
Future<LearningModuleJobResponse>	getLearningModuleJobAsync(GetLearningModuleJobRequest request, AsyncApiCallback<LearningModuleJobResponse> callback)	Get a specific Learning Module job status
Future<ApiResponse<LearningModuleJobResponse>>	getLearningModuleJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModuleJobResponse>> callback)	Get a specific Learning Module job status
Future<LearningModulePreviewGetResponse>	getLearningModulePreviewAsync(GetLearningModulePreviewRequest request, AsyncApiCallback<LearningModulePreviewGetResponse> callback)	Get a learning module preview
Future<ApiResponse<LearningModulePreviewGetResponse>>	getLearningModulePreviewAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModulePreviewGetResponse>> callback)	Get a learning module preview
Future<LearningModuleRule>	getLearningModuleRuleAsync(GetLearningModuleRuleRequest request, AsyncApiCallback<LearningModuleRule> callback)	Get a learning module rule
Future<ApiResponse<LearningModuleRule>>	getLearningModuleRuleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModuleRule>> callback)	Get a learning module rule
Future<AssignedLearningModuleDomainEntityListing>	getLearningModulesAssignmentsAsync(GetLearningModulesAssignmentsRequest request, AsyncApiCallback<AssignedLearningModuleDomainEntityListing> callback)	Get all learning modules of an organization including assignments for a specific user
Future<ApiResponse<AssignedLearningModuleDomainEntityListing>>	getLearningModulesAssignmentsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AssignedLearningModuleDomainEntityListing>> callback)	Get all learning modules of an organization including assignments for a specific user
Future<LearningModuleList>	getLearningModulesAsync(GetLearningModulesRequest request, AsyncApiCallback<LearningModuleList> callback)	Get all learning modules of an organization
Future<ApiResponse<LearningModuleList>>	getLearningModulesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModuleList>> callback)	Get all learning modules of an organization
Future<LearningModuleCoverArtResponse>	getLearningModulesCoverartCoverArtIdAsync(GetLearningModulesCoverartCoverArtIdRequest request, AsyncApiCallback<LearningModuleCoverArtResponse> callback)	Get a specific Learning Module cover art using ID
Future<ApiResponse<LearningModuleCoverArtResponse>>	getLearningModulesCoverartCoverArtIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModuleCoverArtResponse>> callback)	Get a specific Learning Module cover art using ID
Future<LearningModule>	getLearningModuleVersionAsync(GetLearningModuleVersionRequest request, AsyncApiCallback<LearningModule> callback)	Get specific version of a published module
Future<ApiResponse<LearningModule>>	getLearningModuleVersionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModule>> callback)	Get specific version of a published module
Future<LearningScheduleSlotsJobResponse>	getLearningScheduleslotsJobAsync(GetLearningScheduleslotsJobRequest request, AsyncApiCallback<LearningScheduleSlotsJobResponse> callback)	Retrieve the status of the job for the slots where a learning activity can be scheduled.
Future<ApiResponse<LearningScheduleSlotsJobResponse>>	getLearningScheduleslotsJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningScheduleSlotsJobResponse>> callback)	Retrieve the status of the job for the slots where a learning activity can be scheduled.
Future<LearningScormResponse>	getLearningScormScormIdAsync(GetLearningScormScormIdRequest request, AsyncApiCallback<LearningScormResponse> callback)	Get Learning SCORM Result
Future<ApiResponse<LearningScormResponse>>	getLearningScormScormIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningScormResponse>> callback)	Get Learning SCORM Result
Future<LearningAssignment>	patchLearningAssignmentAsync(PatchLearningAssignmentRequest request, AsyncApiCallback<LearningAssignment> callback)	Update Learning Assignment
Future<ApiResponse<LearningAssignment>>	patchLearningAssignmentAsync(ApiRequest<LearningAssignmentUpdate> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Update Learning Assignment
Future<LearningAssignment>	patchLearningAssignmentRescheduleAsync(PatchLearningAssignmentRescheduleRequest request, AsyncApiCallback<LearningAssignment> callback)	Reschedule Learning Assignment
Future<ApiResponse<LearningAssignment>>	patchLearningAssignmentRescheduleAsync(ApiRequest<LearningAssignmentReschedule> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Reschedule Learning Assignment
Future<LearningAssignmentStep>	patchLearningAssignmentStepAsync(PatchLearningAssignmentStepRequest request, AsyncApiCallback<LearningAssignmentStep> callback)	Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
Future<ApiResponse<LearningAssignmentStep>>	patchLearningAssignmentStepAsync(ApiRequest<LearningAssignmentStep> request, AsyncApiCallback<ApiResponse<LearningAssignmentStep>> callback)	Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment
Future<LearningAssignment>	patchLearningModuleUserAssignmentsAsync(PatchLearningModuleUserAssignmentsRequest request, AsyncApiCallback<LearningAssignment> callback)	Update an external assignment for a specific user
Future<ApiResponse<LearningAssignment>>	patchLearningModuleUserAssignmentsAsync(ApiRequest<LearningAssignmentExternalUpdate> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Update an external assignment for a specific user
Future<AssessmentScoringSet>	postLearningAssessmentsScoringAsync(PostLearningAssessmentsScoringRequest request, AsyncApiCallback<AssessmentScoringSet> callback)	Score learning assessment for preview
Future<ApiResponse<AssessmentScoringSet>>	postLearningAssessmentsScoringAsync(ApiRequest<LearningAssessmentScoringRequest> request, AsyncApiCallback<ApiResponse<AssessmentScoringSet>> callback)	Score learning assessment for preview
Future<LearningAssignment>	postLearningAssignmentReassignAsync(PostLearningAssignmentReassignRequest request, AsyncApiCallback<LearningAssignment> callback)	Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module
Future<ApiResponse<LearningAssignment>>	postLearningAssignmentReassignAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module
Future<LearningAssignment>	postLearningAssignmentResetAsync(PostLearningAssignmentResetRequest request, AsyncApiCallback<LearningAssignment> callback)	Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment
Future<ApiResponse<LearningAssignment>>	postLearningAssignmentResetAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment
Future<LearningAssignmentAggregateResponse>	postLearningAssignmentsAggregatesQueryAsync(PostLearningAssignmentsAggregatesQueryRequest request, AsyncApiCallback<LearningAssignmentAggregateResponse> callback)	Retrieve aggregated assignment data
Future<ApiResponse<LearningAssignmentAggregateResponse>>	postLearningAssignmentsAggregatesQueryAsync(ApiRequest<LearningAssignmentAggregateParam> request, AsyncApiCallback<ApiResponse<LearningAssignmentAggregateResponse>> callback)	Retrieve aggregated assignment data
Future<LearningAssignment>	postLearningAssignmentsAsync(PostLearningAssignmentsRequest request, AsyncApiCallback<LearningAssignment> callback)	Create Learning Assignment
Future<ApiResponse<LearningAssignment>>	postLearningAssignmentsAsync(ApiRequest<LearningAssignmentCreate> request, AsyncApiCallback<ApiResponse<LearningAssignment>> callback)	Create Learning Assignment
Future<LearningAssignmentBulkAddResponse>	postLearningAssignmentsBulkaddAsync(PostLearningAssignmentsBulkaddRequest request, AsyncApiCallback<LearningAssignmentBulkAddResponse> callback)	Add multiple learning assignments
Future<ApiResponse<LearningAssignmentBulkAddResponse>>	postLearningAssignmentsBulkaddAsync(ApiRequest<List<LearningAssignmentItem>> request, AsyncApiCallback<ApiResponse<LearningAssignmentBulkAddResponse>> callback)	Add multiple learning assignments
Future<LearningAssignmentBulkRemoveResponse>	postLearningAssignmentsBulkremoveAsync(PostLearningAssignmentsBulkremoveRequest request, AsyncApiCallback<LearningAssignmentBulkRemoveResponse> callback)	Remove multiple Learning Assignments
Future<ApiResponse<LearningAssignmentBulkRemoveResponse>>	postLearningAssignmentsBulkremoveAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<LearningAssignmentBulkRemoveResponse>> callback)	Remove multiple Learning Assignments
Future<LearningModuleJobResponse>	postLearningModuleJobsAsync(PostLearningModuleJobsRequest request, AsyncApiCallback<LearningModuleJobResponse> callback)	Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module
Future<ApiResponse<LearningModuleJobResponse>>	postLearningModuleJobsAsync(ApiRequest<LearningModuleJobRequest> request, AsyncApiCallback<ApiResponse<LearningModuleJobResponse>> callback)	Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module
Future<LearningModulePublishResponse>	postLearningModulePublishAsync(PostLearningModulePublishRequest request, AsyncApiCallback<LearningModulePublishResponse> callback)	Publish a Learning module
Future<ApiResponse<LearningModulePublishResponse>>	postLearningModulePublishAsync(ApiRequest<LearningModulePublishRequest> request, AsyncApiCallback<ApiResponse<LearningModulePublishResponse>> callback)	Publish a Learning module
Future<LearningModuleMigrateResponse>	postLearningModuleRuleMigrateAsync(PostLearningModuleRuleMigrateRequest request, AsyncApiCallback<LearningModuleMigrateResponse> callback)	Migrate a legacy learning module rule to a users rule.
Future<ApiResponse<LearningModuleMigrateResponse>>	postLearningModuleRuleMigrateAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<LearningModuleMigrateResponse>> callback)	Migrate a legacy learning module rule to a users rule.
Future<LearningModule>	postLearningModulesAsync(PostLearningModulesRequest request, AsyncApiCallback<LearningModule> callback)	Create a new learning module This will create a new unpublished learning module with the specified fields.
Future<ApiResponse<LearningModule>>	postLearningModulesAsync(ApiRequest<LearningModuleRequest> request, AsyncApiCallback<ApiResponse<LearningModule>> callback)	Create a new learning module This will create a new unpublished learning module with the specified fields.
Future<LearningAssignmentUserListing>	postLearningRulesQueryAsync(PostLearningRulesQueryRequest request, AsyncApiCallback<LearningAssignmentUserListing> callback)	Get users for learning module rule This will get the users who matches the given rule.
Future<ApiResponse<LearningAssignmentUserListing>>	postLearningRulesQueryAsync(ApiRequest<LearningAssignmentUserQuery> request, AsyncApiCallback<ApiResponse<LearningAssignmentUserListing>> callback)	Get users for learning module rule This will get the users who matches the given rule.
Future<LearningScheduleSlotsJobResponse>	postLearningScheduleslotsJobsAsync(PostLearningScheduleslotsJobsRequest request, AsyncApiCallback<LearningScheduleSlotsJobResponse> callback)	Start job to retrieve slots where a learning activity can be scheduled.
Future<ApiResponse<LearningScheduleSlotsJobResponse>>	postLearningScheduleslotsJobsAsync(ApiRequest<LearningScheduleSlotsJobRequest> request, AsyncApiCallback<ApiResponse<LearningScheduleSlotsJobResponse>> callback)	Start job to retrieve slots where a learning activity can be scheduled.
Future<LearningScheduleSlotsQueryResponse>	postLearningScheduleslotsQueryAsync(PostLearningScheduleslotsQueryRequest request, AsyncApiCallback<LearningScheduleSlotsQueryResponse> callback)	Get list of possible slots where a learning activity can be scheduled.
Future<ApiResponse<LearningScheduleSlotsQueryResponse>>	postLearningScheduleslotsQueryAsync(ApiRequest<LearningScheduleSlotsQueryRequest> request, AsyncApiCallback<ApiResponse<LearningScheduleSlotsQueryResponse>> callback)	Get list of possible slots where a learning activity can be scheduled.
Future<LearningScormUploadResponse>	postLearningScormAsync(PostLearningScormRequest request, AsyncApiCallback<LearningScormUploadResponse> callback)	Create a SCORM package upload request
Future<ApiResponse<LearningScormUploadResponse>>	postLearningScormAsync(ApiRequest<LearningScormUploadRequest> request, AsyncApiCallback<ApiResponse<LearningScormUploadResponse>> callback)	Create a SCORM package upload request
Future<LearningModule>	putLearningModuleAsync(PutLearningModuleRequest request, AsyncApiCallback<LearningModule> callback)	Update a learning module This will update the name, description, completion time in days and inform steps for a learning module
Future<ApiResponse<LearningModule>>	putLearningModuleAsync(ApiRequest<LearningModuleRequest> request, AsyncApiCallback<ApiResponse<LearningModule>> callback)	Update a learning module This will update the name, description, completion time in days and inform steps for a learning module
Future<LearningModulePreviewUpdateResponse>	putLearningModulePreviewAsync(PutLearningModulePreviewRequest request, AsyncApiCallback<LearningModulePreviewUpdateResponse> callback)	Update a learning module preview This will update a learning module preview
Future<ApiResponse<LearningModulePreviewUpdateResponse>>	putLearningModulePreviewAsync(ApiRequest<LearningModulePreviewUpdateRequest> request, AsyncApiCallback<ApiResponse<LearningModulePreviewUpdateResponse>> callback)	Update a learning module preview This will update a learning module preview
Future<LearningModuleRule>	putLearningModuleRuleAsync(PutLearningModuleRuleRequest request, AsyncApiCallback<LearningModuleRule> callback)	Update a learning module rule This will update a learning module rule with the specified fields.
Future<ApiResponse<LearningModuleRule>>	putLearningModuleRuleAsync(ApiRequest<LearningModuleRule> request, AsyncApiCallback<ApiResponse<LearningModuleRule>> callback)	Update a learning module rule This will update a learning module rule with the specified fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LearningApiAsync

public LearningApiAsync()

LearningApiAsync

public LearningApiAsync(ApiClient apiClient)

Method Details

deleteLearningAssignmentAsync

public Future<Void> deleteLearningAssignmentAsync(DeleteLearningAssignmentRequest request,
 AsyncApiCallback<Void> callback)

Delete a learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteLearningAssignmentAsync

public Future<ApiResponse<Void>> deleteLearningAssignmentAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Void>> callback)

Delete a learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteLearningModuleAsync

public Future<Void> deleteLearningModuleAsync(DeleteLearningModuleRequest request,
 AsyncApiCallback<Void> callback)

Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteLearningModuleAsync

public Future<ApiResponse<Void>> deleteLearningModuleAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Void>> callback)

Delete a learning module This will delete a learning module if it is unpublished or it will delete a published and archived learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentAsync

public Future<LearningAssignment> getLearningAssignmentAsync(GetLearningAssignmentRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Get Learning Assignment Permission not required if you are the assigned user of the learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentAsync

public Future<ApiResponse<LearningAssignment>> getLearningAssignmentAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Get Learning Assignment Permission not required if you are the assigned user of the learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentStepAsync

public Future<LearningAssignmentStep> getLearningAssignmentStepAsync(GetLearningAssignmentStepRequest request,
 AsyncApiCallback<LearningAssignmentStep> callback)

Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentStepAsync

public Future<ApiResponse<LearningAssignmentStep>> getLearningAssignmentStepAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentStep>> callback)

Get Learning Assignment Step Permission not required if you are the assigned user of the learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentsAsync

public Future<LearningAssignmentsDomainEntity> getLearningAssignmentsAsync(GetLearningAssignmentsRequest request,
 AsyncApiCallback<LearningAssignmentsDomainEntity> callback)

List of Learning module Assignments Either moduleId or user value is required

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentsAsync

public Future<ApiResponse<LearningAssignmentsDomainEntity>> getLearningAssignmentsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentsDomainEntity>> callback)

List of Learning module Assignments Either moduleId or user value is required

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentsMeAsync

public Future<LearningAssignmentsDomainEntity> getLearningAssignmentsMeAsync(GetLearningAssignmentsMeRequest request,
 AsyncApiCallback<LearningAssignmentsDomainEntity> callback)

List of Learning Assignments assigned to current user

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningAssignmentsMeAsync

public Future<ApiResponse<LearningAssignmentsDomainEntity>> getLearningAssignmentsMeAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentsDomainEntity>> callback)

List of Learning Assignments assigned to current user

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleAsync

public Future<LearningModule> getLearningModuleAsync(GetLearningModuleRequest request,
 AsyncApiCallback<LearningModule> callback)

Get a learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleAsync

public Future<ApiResponse<LearningModule>> getLearningModuleAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModule>> callback)

Get a learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleJobAsync

public Future<LearningModuleJobResponse> getLearningModuleJobAsync(GetLearningModuleJobRequest request,
 AsyncApiCallback<LearningModuleJobResponse> callback)

Get a specific Learning Module job status

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleJobAsync

public Future<ApiResponse<LearningModuleJobResponse>> getLearningModuleJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModuleJobResponse>> callback)

Get a specific Learning Module job status

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulePreviewAsync

public Future<LearningModulePreviewGetResponse> getLearningModulePreviewAsync(GetLearningModulePreviewRequest request,
 AsyncApiCallback<LearningModulePreviewGetResponse> callback)

Get a learning module preview

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulePreviewAsync

public Future<ApiResponse<LearningModulePreviewGetResponse>> getLearningModulePreviewAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModulePreviewGetResponse>> callback)

Get a learning module preview

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleRuleAsync

public Future<LearningModuleRule> getLearningModuleRuleAsync(GetLearningModuleRuleRequest request,
 AsyncApiCallback<LearningModuleRule> callback)

Get a learning module rule

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleRuleAsync

public Future<ApiResponse<LearningModuleRule>> getLearningModuleRuleAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModuleRule>> callback)

Get a learning module rule

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleVersionAsync

public Future<LearningModule> getLearningModuleVersionAsync(GetLearningModuleVersionRequest request,
 AsyncApiCallback<LearningModule> callback)

Get specific version of a published module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModuleVersionAsync

public Future<ApiResponse<LearningModule>> getLearningModuleVersionAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModule>> callback)

Get specific version of a published module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulesAsync

public Future<LearningModuleList> getLearningModulesAsync(GetLearningModulesRequest request,
 AsyncApiCallback<LearningModuleList> callback)

Get all learning modules of an organization

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulesAsync

public Future<ApiResponse<LearningModuleList>> getLearningModulesAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModuleList>> callback)

Get all learning modules of an organization

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulesAssignmentsAsync

public Future<AssignedLearningModuleDomainEntityListing> getLearningModulesAssignmentsAsync(GetLearningModulesAssignmentsRequest request,
 AsyncApiCallback<AssignedLearningModuleDomainEntityListing> callback)

Get all learning modules of an organization including assignments for a specific user

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulesAssignmentsAsync

public Future<ApiResponse<AssignedLearningModuleDomainEntityListing>> getLearningModulesAssignmentsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<AssignedLearningModuleDomainEntityListing>> callback)

Get all learning modules of an organization including assignments for a specific user

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulesCoverartCoverArtIdAsync

public Future<LearningModuleCoverArtResponse> getLearningModulesCoverartCoverArtIdAsync(GetLearningModulesCoverartCoverArtIdRequest request,
 AsyncApiCallback<LearningModuleCoverArtResponse> callback)

Get a specific Learning Module cover art using ID

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningModulesCoverartCoverArtIdAsync

public Future<ApiResponse<LearningModuleCoverArtResponse>> getLearningModulesCoverartCoverArtIdAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModuleCoverArtResponse>> callback)

Get a specific Learning Module cover art using ID

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningScheduleslotsJobAsync

public Future<LearningScheduleSlotsJobResponse> getLearningScheduleslotsJobAsync(GetLearningScheduleslotsJobRequest request,
 AsyncApiCallback<LearningScheduleSlotsJobResponse> callback)

Retrieve the status of the job for the slots where a learning activity can be scheduled.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningScheduleslotsJobAsync

public Future<ApiResponse<LearningScheduleSlotsJobResponse>> getLearningScheduleslotsJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningScheduleSlotsJobResponse>> callback)

Retrieve the status of the job for the slots where a learning activity can be scheduled.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningScormScormIdAsync

public Future<LearningScormResponse> getLearningScormScormIdAsync(GetLearningScormScormIdRequest request,
 AsyncApiCallback<LearningScormResponse> callback)

Get Learning SCORM Result

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getLearningScormScormIdAsync

public Future<ApiResponse<LearningScormResponse>> getLearningScormScormIdAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningScormResponse>> callback)

Get Learning SCORM Result

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningAssignmentAsync

public Future<LearningAssignment> patchLearningAssignmentAsync(PatchLearningAssignmentRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Update Learning Assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningAssignmentAsync

public Future<ApiResponse<LearningAssignment>> patchLearningAssignmentAsync(ApiRequest<LearningAssignmentUpdate> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Update Learning Assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningAssignmentRescheduleAsync

public Future<LearningAssignment> patchLearningAssignmentRescheduleAsync(PatchLearningAssignmentRescheduleRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Reschedule Learning Assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningAssignmentRescheduleAsync

public Future<ApiResponse<LearningAssignment>> patchLearningAssignmentRescheduleAsync(ApiRequest<LearningAssignmentReschedule> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Reschedule Learning Assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningAssignmentStepAsync

public Future<LearningAssignmentStep> patchLearningAssignmentStepAsync(PatchLearningAssignmentStepRequest request,
 AsyncApiCallback<LearningAssignmentStep> callback)

Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningAssignmentStepAsync

public Future<ApiResponse<LearningAssignmentStep>> patchLearningAssignmentStepAsync(ApiRequest<LearningAssignmentStep> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentStep>> callback)

Update Learning Assignment Step Permission not required if you are the assigned user of the learning assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningModuleUserAssignmentsAsync

public Future<LearningAssignment> patchLearningModuleUserAssignmentsAsync(PatchLearningModuleUserAssignmentsRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Update an external assignment for a specific user

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchLearningModuleUserAssignmentsAsync

public Future<ApiResponse<LearningAssignment>> patchLearningModuleUserAssignmentsAsync(ApiRequest<LearningAssignmentExternalUpdate> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Update an external assignment for a specific user

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssessmentsScoringAsync

public Future<AssessmentScoringSet> postLearningAssessmentsScoringAsync(PostLearningAssessmentsScoringRequest request,
 AsyncApiCallback<AssessmentScoringSet> callback)

Score learning assessment for preview

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssessmentsScoringAsync

public Future<ApiResponse<AssessmentScoringSet>> postLearningAssessmentsScoringAsync(ApiRequest<LearningAssessmentScoringRequest> request,
 AsyncApiCallback<ApiResponse<AssessmentScoringSet>> callback)

Score learning assessment for preview

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentReassignAsync

public Future<LearningAssignment> postLearningAssignmentReassignAsync(PostLearningAssignmentReassignRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentReassignAsync

public Future<ApiResponse<LearningAssignment>> postLearningAssignmentReassignAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Reassign Learning Assignment This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentResetAsync

public Future<LearningAssignment> postLearningAssignmentResetAsync(PostLearningAssignmentResetRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentResetAsync

public Future<ApiResponse<LearningAssignment>> postLearningAssignmentResetAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Reset Learning Assignment This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsAsync

public Future<LearningAssignment> postLearningAssignmentsAsync(PostLearningAssignmentsRequest request,
 AsyncApiCallback<LearningAssignment> callback)

Create Learning Assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsAsync

public Future<ApiResponse<LearningAssignment>> postLearningAssignmentsAsync(ApiRequest<LearningAssignmentCreate> request,
 AsyncApiCallback<ApiResponse<LearningAssignment>> callback)

Create Learning Assignment

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsAggregatesQueryAsync

public Future<LearningAssignmentAggregateResponse> postLearningAssignmentsAggregatesQueryAsync(PostLearningAssignmentsAggregatesQueryRequest request,
 AsyncApiCallback<LearningAssignmentAggregateResponse> callback)

Retrieve aggregated assignment data

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsAggregatesQueryAsync

public Future<ApiResponse<LearningAssignmentAggregateResponse>> postLearningAssignmentsAggregatesQueryAsync(ApiRequest<LearningAssignmentAggregateParam> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentAggregateResponse>> callback)

Retrieve aggregated assignment data

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsBulkaddAsync

public Future<LearningAssignmentBulkAddResponse> postLearningAssignmentsBulkaddAsync(PostLearningAssignmentsBulkaddRequest request,
 AsyncApiCallback<LearningAssignmentBulkAddResponse> callback)

Add multiple learning assignments

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsBulkaddAsync

public Future<ApiResponse<LearningAssignmentBulkAddResponse>> postLearningAssignmentsBulkaddAsync(ApiRequest<List<LearningAssignmentItem>> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentBulkAddResponse>> callback)

Add multiple learning assignments

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsBulkremoveAsync

public Future<LearningAssignmentBulkRemoveResponse> postLearningAssignmentsBulkremoveAsync(PostLearningAssignmentsBulkremoveRequest request,
 AsyncApiCallback<LearningAssignmentBulkRemoveResponse> callback)

Remove multiple Learning Assignments

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningAssignmentsBulkremoveAsync

public Future<ApiResponse<LearningAssignmentBulkRemoveResponse>> postLearningAssignmentsBulkremoveAsync(ApiRequest<List<String>> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentBulkRemoveResponse>> callback)

Remove multiple Learning Assignments

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModuleJobsAsync

public Future<LearningModuleJobResponse> postLearningModuleJobsAsync(PostLearningModuleJobsRequest request,
 AsyncApiCallback<LearningModuleJobResponse> callback)

Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModuleJobsAsync

public Future<ApiResponse<LearningModuleJobResponse>> postLearningModuleJobsAsync(ApiRequest<LearningModuleJobRequest> request,
 AsyncApiCallback<ApiResponse<LearningModuleJobResponse>> callback)

Starts a specified operation on learning module This will initiate operation specified in the request body for a learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModulePublishAsync

public Future<LearningModulePublishResponse> postLearningModulePublishAsync(PostLearningModulePublishRequest request,
 AsyncApiCallback<LearningModulePublishResponse> callback)

Publish a Learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModulePublishAsync

public Future<ApiResponse<LearningModulePublishResponse>> postLearningModulePublishAsync(ApiRequest<LearningModulePublishRequest> request,
 AsyncApiCallback<ApiResponse<LearningModulePublishResponse>> callback)

Publish a Learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModuleRuleMigrateAsync

public Future<LearningModuleMigrateResponse> postLearningModuleRuleMigrateAsync(PostLearningModuleRuleMigrateRequest request,
 AsyncApiCallback<LearningModuleMigrateResponse> callback)

Migrate a legacy learning module rule to a users rule. postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModuleRuleMigrateAsync

public Future<ApiResponse<LearningModuleMigrateResponse>> postLearningModuleRuleMigrateAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<LearningModuleMigrateResponse>> callback)

Migrate a legacy learning module rule to a users rule. postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModulesAsync

public Future<LearningModule> postLearningModulesAsync(PostLearningModulesRequest request,
 AsyncApiCallback<LearningModule> callback)

Create a new learning module This will create a new unpublished learning module with the specified fields.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningModulesAsync

public Future<ApiResponse<LearningModule>> postLearningModulesAsync(ApiRequest<LearningModuleRequest> request,
 AsyncApiCallback<ApiResponse<LearningModule>> callback)

Create a new learning module This will create a new unpublished learning module with the specified fields.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningRulesQueryAsync

public Future<LearningAssignmentUserListing> postLearningRulesQueryAsync(PostLearningRulesQueryRequest request,
 AsyncApiCallback<LearningAssignmentUserListing> callback)

Get users for learning module rule This will get the users who matches the given rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningRulesQueryAsync

public Future<ApiResponse<LearningAssignmentUserListing>> postLearningRulesQueryAsync(ApiRequest<LearningAssignmentUserQuery> request,
 AsyncApiCallback<ApiResponse<LearningAssignmentUserListing>> callback)

Get users for learning module rule This will get the users who matches the given rule.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningScheduleslotsJobsAsync

public Future<LearningScheduleSlotsJobResponse> postLearningScheduleslotsJobsAsync(PostLearningScheduleslotsJobsRequest request,
 AsyncApiCallback<LearningScheduleSlotsJobResponse> callback)

Start job to retrieve slots where a learning activity can be scheduled.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningScheduleslotsJobsAsync

public Future<ApiResponse<LearningScheduleSlotsJobResponse>> postLearningScheduleslotsJobsAsync(ApiRequest<LearningScheduleSlotsJobRequest> request,
 AsyncApiCallback<ApiResponse<LearningScheduleSlotsJobResponse>> callback)

Start job to retrieve slots where a learning activity can be scheduled.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningScheduleslotsQueryAsync

public Future<LearningScheduleSlotsQueryResponse> postLearningScheduleslotsQueryAsync(PostLearningScheduleslotsQueryRequest request,
 AsyncApiCallback<LearningScheduleSlotsQueryResponse> callback)

Get list of possible slots where a learning activity can be scheduled.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningScheduleslotsQueryAsync

public Future<ApiResponse<LearningScheduleSlotsQueryResponse>> postLearningScheduleslotsQueryAsync(ApiRequest<LearningScheduleSlotsQueryRequest> request,
 AsyncApiCallback<ApiResponse<LearningScheduleSlotsQueryResponse>> callback)

Get list of possible slots where a learning activity can be scheduled.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningScormAsync

public Future<LearningScormUploadResponse> postLearningScormAsync(PostLearningScormRequest request,
 AsyncApiCallback<LearningScormUploadResponse> callback)

Create a SCORM package upload request

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postLearningScormAsync

public Future<ApiResponse<LearningScormUploadResponse>> postLearningScormAsync(ApiRequest<LearningScormUploadRequest> request,
 AsyncApiCallback<ApiResponse<LearningScormUploadResponse>> callback)

Create a SCORM package upload request

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putLearningModuleAsync

public Future<LearningModule> putLearningModuleAsync(PutLearningModuleRequest request,
 AsyncApiCallback<LearningModule> callback)

Update a learning module This will update the name, description, completion time in days and inform steps for a learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putLearningModuleAsync

public Future<ApiResponse<LearningModule>> putLearningModuleAsync(ApiRequest<LearningModuleRequest> request,
 AsyncApiCallback<ApiResponse<LearningModule>> callback)

Update a learning module This will update the name, description, completion time in days and inform steps for a learning module

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putLearningModulePreviewAsync

public Future<LearningModulePreviewUpdateResponse> putLearningModulePreviewAsync(PutLearningModulePreviewRequest request,
 AsyncApiCallback<LearningModulePreviewUpdateResponse> callback)

Update a learning module preview This will update a learning module preview

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putLearningModulePreviewAsync

public Future<ApiResponse<LearningModulePreviewUpdateResponse>> putLearningModulePreviewAsync(ApiRequest<LearningModulePreviewUpdateRequest> request,
 AsyncApiCallback<ApiResponse<LearningModulePreviewUpdateResponse>> callback)

Update a learning module preview This will update a learning module preview

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putLearningModuleRuleAsync

public Future<LearningModuleRule> putLearningModuleRuleAsync(PutLearningModuleRuleRequest request,
 AsyncApiCallback<LearningModuleRule> callback)

Update a learning module rule This will update a learning module rule with the specified fields.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putLearningModuleRuleAsync

public Future<ApiResponse<LearningModuleRule>> putLearningModuleRuleAsync(ApiRequest<LearningModuleRule> request,
 AsyncApiCallback<ApiResponse<LearningModuleRule>> callback)

Update a learning module rule This will update a learning module rule with the specified fields.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed