@@ -443,7 +443,7 @@ export type DialogState = 'STARTED' | 'IN_PROGRESS' | 'COMPLETED';
443
443
*
444
444
* @interface
445
445
*/
446
- export type Directive = interfaces . customInterfaceController . StopEventHandlerDirective | interfaces . navigation . assistance . AnnounceRoadRegulation | interfaces . connections . SendRequestDirective | dialog . DynamicEntitiesDirective | interfaces . customInterfaceController . StartEventHandlerDirective | interfaces . gadgetController . SetLightDirective | dialog . DelegateDirective | dialog . ConfirmIntentDirective | interfaces . customInterfaceController . SendDirectiveDirective | interfaces . alexa . presentation . html . HandleMessageDirective | dialog . ElicitSlotDirective | interfaces . alexa . presentation . html . StartDirective | interfaces . audioplayer . StopDirective | dialog . ConfirmSlotDirective | interfaces . audioplayer . PlayDirective | interfaces . alexa . presentation . apl . ExecuteCommandsDirective | interfaces . display . RenderTemplateDirective | interfaces . display . HintDirective | interfaces . connections . V1 . StartConnectionDirective | interfaces . alexa . presentation . aplt . RenderDocumentDirective | interfaces . gameEngine . StartInputHandlerDirective | interfaces . videoapp . LaunchDirective | interfaces . alexa . presentation . aplt . ExecuteCommandsDirective | interfaces . gameEngine . StopInputHandlerDirective | interfaces . tasks . CompleteTaskDirective | interfaces . alexa . presentation . apl . RenderDocumentDirective | interfaces . connections . SendResponseDirective | interfaces . audioplayer . ClearQueueDirective ;
446
+ export type Directive = interfaces . customInterfaceController . StopEventHandlerDirective | interfaces . navigation . assistance . AnnounceRoadRegulation | interfaces . connections . SendRequestDirective | dialog . DynamicEntitiesDirective | interfaces . customInterfaceController . StartEventHandlerDirective | interfaces . gadgetController . SetLightDirective | interfaces . alexa . presentation . apl . SendIndexListDataDirective | dialog . DelegateDirective | dialog . ConfirmIntentDirective | interfaces . customInterfaceController . SendDirectiveDirective | interfaces . alexa . presentation . html . HandleMessageDirective | dialog . ElicitSlotDirective | interfaces . alexa . presentation . html . StartDirective | interfaces . audioplayer . StopDirective | dialog . ConfirmSlotDirective | interfaces . audioplayer . PlayDirective | interfaces . alexa . presentation . apl . ExecuteCommandsDirective | interfaces . display . RenderTemplateDirective | interfaces . display . HintDirective | interfaces . connections . V1 . StartConnectionDirective | interfaces . alexa . presentation . aplt . RenderDocumentDirective | interfaces . gameEngine . StartInputHandlerDirective | interfaces . videoapp . LaunchDirective | interfaces . alexa . presentation . aplt . ExecuteCommandsDirective | interfaces . gameEngine . StopInputHandlerDirective | interfaces . tasks . CompleteTaskDirective | interfaces . alexa . presentation . apl . RenderDocumentDirective | interfaces . connections . SendResponseDirective | interfaces . audioplayer . ClearQueueDirective | interfaces . alexa . presentation . apl . UpdateIndexListDataDirective ;
447
447
448
448
/**
449
449
* An object that represents what the user wants.
@@ -489,7 +489,7 @@ export interface Person {
489
489
* A request object that provides the details of the user’s request. The request body contains the parameters necessary for the service to perform its logic and generate a response.
490
490
* @interface
491
491
*/
492
- export type Request = events . skillevents . SkillEnabledRequest | services . listManagement . ListUpdatedEventRequest | interfaces . alexa . presentation . apl . UserEvent | events . skillevents . SkillDisabledRequest | services . listManagement . ListItemsCreatedEventRequest | SessionResumedRequest | SessionEndedRequest | interfaces . audioplayer . PlaybackFailedRequest | canfulfill . CanFulfillIntentRequest | interfaces . customInterfaceController . ExpiredRequest | interfaces . alexa . presentation . html . MessageRequest | LaunchRequest | services . reminderManagement . ReminderCreatedEventRequest | interfaces . alexa . presentation . aplt . UserEvent | services . listManagement . ListItemsUpdatedEventRequest | services . listManagement . ListCreatedEventRequest | interfaces . audioplayer . PlaybackStartedRequest | interfaces . audioplayer . PlaybackNearlyFinishedRequest | interfaces . customInterfaceController . EventsReceivedRequest | services . reminderManagement . ReminderStatusChangedEventRequest | services . listManagement . ListItemsDeletedEventRequest | services . reminderManagement . ReminderDeletedEventRequest | interfaces . connections . ConnectionsResponse | services . listManagement . ListDeletedEventRequest | interfaces . gameEngine . InputHandlerEventRequest | interfaces . playbackcontroller . PauseCommandIssuedRequest | interfaces . playbackcontroller . PlayCommandIssuedRequest | interfaces . audioplayer . PlaybackFinishedRequest | events . skillevents . ProactiveSubscriptionChangedRequest | interfaces . display . ElementSelectedRequest | events . skillevents . PermissionChangedRequest | services . reminderManagement . ReminderUpdatedEventRequest | interfaces . alexa . presentation . html . RuntimeErrorRequest | IntentRequest | services . reminderManagement . ReminderStartedEventRequest | interfaces . audioplayer . PlaybackStoppedRequest | interfaces . playbackcontroller . PreviousCommandIssuedRequest | events . skillevents . AccountLinkedRequest | interfaces . messaging . MessageReceivedRequest | interfaces . connections . ConnectionsRequest | interfaces . system . ExceptionEncounteredRequest | events . skillevents . PermissionAcceptedRequest | interfaces . playbackcontroller . NextCommandIssuedRequest ;
492
+ export type Request = events . skillevents . SkillEnabledRequest | services . listManagement . ListUpdatedEventRequest | interfaces . alexa . presentation . apl . UserEvent | events . skillevents . SkillDisabledRequest | services . listManagement . ListItemsCreatedEventRequest | SessionResumedRequest | SessionEndedRequest | interfaces . alexa . presentation . apl . LoadIndexListDataEvent | interfaces . audioplayer . PlaybackFailedRequest | canfulfill . CanFulfillIntentRequest | interfaces . customInterfaceController . ExpiredRequest | interfaces . alexa . presentation . html . MessageRequest | LaunchRequest | services . reminderManagement . ReminderCreatedEventRequest | interfaces . alexa . presentation . aplt . UserEvent | services . listManagement . ListItemsUpdatedEventRequest | services . listManagement . ListCreatedEventRequest | interfaces . audioplayer . PlaybackStartedRequest | interfaces . audioplayer . PlaybackNearlyFinishedRequest | interfaces . customInterfaceController . EventsReceivedRequest | services . reminderManagement . ReminderStatusChangedEventRequest | services . listManagement . ListItemsDeletedEventRequest | services . reminderManagement . ReminderDeletedEventRequest | interfaces . connections . ConnectionsResponse | services . listManagement . ListDeletedEventRequest | interfaces . gameEngine . InputHandlerEventRequest | interfaces . playbackcontroller . PauseCommandIssuedRequest | interfaces . playbackcontroller . PlayCommandIssuedRequest | interfaces . audioplayer . PlaybackFinishedRequest | events . skillevents . ProactiveSubscriptionChangedRequest | interfaces . display . ElementSelectedRequest | events . skillevents . PermissionChangedRequest | services . reminderManagement . ReminderUpdatedEventRequest | interfaces . alexa . presentation . apl . RuntimeErrorEvent | interfaces . alexa . presentation . html . RuntimeErrorRequest | IntentRequest | services . reminderManagement . ReminderStartedEventRequest | interfaces . audioplayer . PlaybackStoppedRequest | interfaces . playbackcontroller . PreviousCommandIssuedRequest | events . skillevents . AccountLinkedRequest | interfaces . messaging . MessageReceivedRequest | interfaces . connections . ConnectionsRequest | interfaces . system . ExceptionEncounteredRequest | events . skillevents . PermissionAcceptedRequest | interfaces . playbackcontroller . NextCommandIssuedRequest ;
493
493
494
494
/**
495
495
* Request wrapper for all requests sent to your Skill.
@@ -984,6 +984,14 @@ export namespace interfaces.alexa.presentation.apl {
984
984
export type HighlightMode = 'block' | 'line' ;
985
985
}
986
986
987
+ export namespace interfaces . alexa . presentation . apl {
988
+ /**
989
+ * The reason for the failure.
990
+ * @enum
991
+ */
992
+ export type ListRuntimeErrorReason = 'INVALID_PRESENTATION_TOKEN' | 'INVALID_LIST_ID' | 'INVALID_DATASOURCE' | 'INVALID_OPERATION' | 'MISSING_LIST_VERSION' | 'DUPLICATE_LIST_VERSION' | 'LIST_INDEX_OUT_OF_RANGE' | 'MISSING_LIST_VERSION_IN_SEND_DATA' | 'LOAD_TIMEOUT' | 'INCONSISTENT_LIST_ID' | 'INCONSISTENT_PAGE_TOKEN' | 'INCONSISTENT_PAGE_ITEMS' | 'DUPLICATE_PAGE_TOKEN' | 'OCCUPIED_LIST_INDEX' | 'LOAD_INDEX_OUT_OF_RANGE' | 'INCONSISTENT_RANGE' | 'MISSING_LIST_ITEMS' | 'INTERNAL_ERROR' ;
993
+ }
994
+
987
995
export namespace interfaces . alexa . presentation . apl {
988
996
/**
989
997
* The command enumerated value is the operation that should be performed on the media player.
@@ -1022,6 +1030,14 @@ export namespace interfaces.alexa.presentation.apl {
1022
1030
}
1023
1031
}
1024
1032
1033
+ export namespace interfaces . alexa . presentation . apl {
1034
+ /**
1035
+ * A description of an error in APL functionality.
1036
+ * @interface
1037
+ */
1038
+ export type RuntimeError = interfaces . alexa . presentation . apl . ListRuntimeError ;
1039
+ }
1040
+
1025
1041
export namespace interfaces . alexa . presentation . apl {
1026
1042
/**
1027
1043
* Transform property to apply to a component.
@@ -1044,6 +1060,14 @@ export namespace interfaces.alexa.presentation.apl {
1044
1060
}
1045
1061
}
1046
1062
1063
+ export namespace interfaces . alexa . presentation . apl . listoperations {
1064
+ /**
1065
+ * An operation which adds, removes or replaces item(s) defined in a dynamicIndexList.
1066
+ * @interface
1067
+ */
1068
+ export type Operation = interfaces . alexa . presentation . apl . listoperations . SetItemOperation | interfaces . alexa . presentation . apl . listoperations . InsertMultipleItemsOperation | interfaces . alexa . presentation . apl . listoperations . DeleteMultipleItemsOperation | interfaces . alexa . presentation . apl . listoperations . InsertItemOperation | interfaces . alexa . presentation . apl . listoperations . DeleteItemOperation ;
1069
+ }
1070
+
1047
1071
export namespace interfaces . alexa . presentation . aplt {
1048
1072
/**
1049
1073
*
@@ -3700,6 +3724,39 @@ export namespace interfaces.alexa.presentation.apl {
3700
3724
}
3701
3725
}
3702
3726
3727
+ export namespace interfaces . alexa . presentation . apl {
3728
+ /**
3729
+ * Reports an error with list functionality.
3730
+ * @interface
3731
+ */
3732
+ export interface ListRuntimeError {
3733
+ 'type' : 'LIST_ERROR' ;
3734
+ 'message' : string ;
3735
+ 'reason' : interfaces . alexa . presentation . apl . ListRuntimeErrorReason ;
3736
+ 'listId' : string ;
3737
+ 'listVersion' ?: number ;
3738
+ 'operationIndex' ?: number ;
3739
+ }
3740
+ }
3741
+
3742
+ export namespace interfaces . alexa . presentation . apl {
3743
+ /**
3744
+ * The LoadIndexListData event is sent to the skill to retrieve additional list items.
3745
+ * @interface
3746
+ */
3747
+ export interface LoadIndexListDataEvent {
3748
+ 'type' : 'Alexa.Presentation.APL.LoadIndexListData' ;
3749
+ 'requestId' : string ;
3750
+ 'timestamp' : string ;
3751
+ 'locale' ?: string ;
3752
+ 'token' : string ;
3753
+ 'correlationToken' : string ;
3754
+ 'listId' : string ;
3755
+ 'startIndex' : number ;
3756
+ 'count' : number ;
3757
+ }
3758
+ }
3759
+
3703
3760
export namespace interfaces . alexa . presentation . apl {
3704
3761
/**
3705
3762
*
@@ -3780,6 +3837,21 @@ export namespace interfaces.alexa.presentation.apl {
3780
3837
}
3781
3838
}
3782
3839
3840
+ export namespace interfaces . alexa . presentation . apl {
3841
+ /**
3842
+ * Notifies the skill of any errors in APL functionality.
3843
+ * @interface
3844
+ */
3845
+ export interface RuntimeErrorEvent {
3846
+ 'type' : 'Alexa.Presentation.APL.RuntimeError' ;
3847
+ 'requestId' : string ;
3848
+ 'timestamp' : string ;
3849
+ 'locale' ?: string ;
3850
+ 'token' : string ;
3851
+ 'errors' : Array < interfaces . alexa . presentation . apl . RuntimeError > ;
3852
+ }
3853
+ }
3854
+
3783
3855
export namespace interfaces . alexa . presentation . apl {
3784
3856
/**
3785
3857
*
@@ -3838,6 +3910,23 @@ export namespace interfaces.alexa.presentation.apl {
3838
3910
}
3839
3911
}
3840
3912
3913
+ export namespace interfaces . alexa . presentation . apl {
3914
+ /**
3915
+ * Returned in response to a LoadIndexListData event, containing the requested items and metadata for further interaction.
3916
+ * @interface
3917
+ */
3918
+ export interface SendIndexListDataDirective {
3919
+ 'type' : 'Alexa.Presentation.APL.SendIndexListData' ;
3920
+ 'correlationToken' ?: string ;
3921
+ 'listId' : string ;
3922
+ 'listVersion' ?: number ;
3923
+ 'startIndex' : number ;
3924
+ 'minimumInclusiveIndex' ?: number ;
3925
+ 'maximumExclusiveIndex' ?: number ;
3926
+ 'items' ?: Array < any > ;
3927
+ }
3928
+ }
3929
+
3841
3930
export namespace interfaces . alexa . presentation . apl {
3842
3931
/**
3843
3932
* A sequential command executes a series of commands in order. The sequential command executes the command list in order, waiting for the previous command to finish before executing the next. The sequential command is finished when all of its child commands have finished. When the Sequential command is terminated early, the currently executing command is terminated and no further commands are executed.
@@ -3963,6 +4052,20 @@ export namespace interfaces.alexa.presentation.apl {
3963
4052
}
3964
4053
}
3965
4054
4055
+ export namespace interfaces . alexa . presentation . apl {
4056
+ /**
4057
+ * Updates the content of an dynamicIndexList datasource which has been previously communicated to an Alexa device.
4058
+ * @interface
4059
+ */
4060
+ export interface UpdateIndexListDataDirective {
4061
+ 'type' : 'Alexa.Presentation.APL.UpdateIndexListData' ;
4062
+ 'token' : string ;
4063
+ 'listId' : string ;
4064
+ 'listVersion' : number ;
4065
+ 'operations' : Array < interfaces . alexa . presentation . apl . listoperations . Operation > ;
4066
+ }
4067
+ }
4068
+
3966
4069
export namespace interfaces . alexa . presentation . apl {
3967
4070
/**
3968
4071
*
@@ -3980,6 +4083,65 @@ export namespace interfaces.alexa.presentation.apl {
3980
4083
}
3981
4084
}
3982
4085
4086
+ export namespace interfaces . alexa . presentation . apl . listoperations {
4087
+ /**
4088
+ * Deletes an item at a specified index in a dynamicIndexList.
4089
+ * @interface
4090
+ */
4091
+ export interface DeleteItemOperation {
4092
+ 'type' : 'DeleteItem' ;
4093
+ 'index' : number ;
4094
+ }
4095
+ }
4096
+
4097
+ export namespace interfaces . alexa . presentation . apl . listoperations {
4098
+ /**
4099
+ * Deletes items at consecutive indexes in a dynamicIndexList.
4100
+ * @interface
4101
+ */
4102
+ export interface DeleteMultipleItemsOperation {
4103
+ 'type' : 'DeleteMultipleItems' ;
4104
+ 'index' : number ;
4105
+ 'count' : number ;
4106
+ }
4107
+ }
4108
+
4109
+ export namespace interfaces . alexa . presentation . apl . listoperations {
4110
+ /**
4111
+ * Inserts a new item at a specified index in a dynamicIndexList.
4112
+ * @interface
4113
+ */
4114
+ export interface InsertItemOperation {
4115
+ 'type' : 'InsertItem' ;
4116
+ 'index' : number ;
4117
+ 'item' : any ;
4118
+ }
4119
+ }
4120
+
4121
+ export namespace interfaces . alexa . presentation . apl . listoperations {
4122
+ /**
4123
+ * Inserts an array of items into consecutive indexes in a dynamicIndexList.
4124
+ * @interface
4125
+ */
4126
+ export interface InsertMultipleItemsOperation {
4127
+ 'type' : 'InsertMultipleItems' ;
4128
+ 'index' : number ;
4129
+ 'items' : Array < any > ;
4130
+ }
4131
+ }
4132
+
4133
+ export namespace interfaces . alexa . presentation . apl . listoperations {
4134
+ /**
4135
+ * Sets an item at a specified index in a dynamicIndexList.
4136
+ * @interface
4137
+ */
4138
+ export interface SetItemOperation {
4139
+ 'type' : 'SetItem' ;
4140
+ 'index' : number ;
4141
+ 'item' : any ;
4142
+ }
4143
+ }
4144
+
3983
4145
export namespace interfaces . alexa . presentation . aplt {
3984
4146
/**
3985
4147
* Automatically progress through a series of pages displayed in a Pager component. The AutoPage command finishes after the last page has been displayed for the requested time period.
0 commit comments