APL Commands Element

Prepares an APL Command.

Currently Supported Commands are:

When to use?

When you add some APL Commands.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Select an APL Command form APL Command Type field.
  3. Fill out the Description field.
  4. Fill out the Delay field.
  5. Fill out the Screen Lock field.
  6. Fill out the When field.
  7. And fill out the rest of the fields for an selected command.

APL Auto Page Command

Adds the AutoPage Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an AutoPage APL Command.

What does this Command do?

The AutoPage command automatically progresses 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.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Component ID field.
  3. Fill out the Count field.
  4. Fill out the Duration field.
  5. Fill out the Delay field.

APL Backstack Clear Command Element

Adds the Backstack Clear Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an Backstack:Clear APL Command.

What does this Command do?

Use the Clear command to explicitly clear the backstack. The backstack is filled when you navigate between different APL Documents, so at some point you want to clear the backstack.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.

APL Backstack Go Back Command Element

Adds the Backstack:GoBack Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an Backstack:GoBack APL Command.

What does this Command do?

The GoBack command returns to a previous document in the backstack.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. If you want you can toggle Use APL Back Type ID the checkbox and fill out the fields below. If the checkbox isn't toggled, the the APL Command will navigate to the previously rendered document.
  3. Fill out the Back Type field. The field will appear if the Use APL Back Type ID is checked.
  4. Fill out the Back Type field. The field will appear if the Use APL Back Type ID is checked.

APL Set Focus Command Element

Adds the ClearFocus Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an ClearFocus APL Command.

What does this Command do?

Removes focus from the actionable component that is currently in focus.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.

APL Finish Command Element

Adds the Finish Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an ClearFocus APL Command.

What does this Command do?

Closes the current APL document and exits.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.

APL Idle Command Element

Adds the Idle Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an Idle APL Command.

What does this Command do?

The Idle command does nothing.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Duration field.

APL Open URL Command Element

Adds the OpenURL Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an OpenURL Command.

What does this Command do?

Open a URL. The OpenURL command, if successful, opens the specified URL in a web browser or other application on the device. You must provide a suitable URL that works on the current device.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Source field.

APL Reinflate Command Element

Adds the Reinflate Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an Reinflate APL Command.

What does this Command do?

Reinflates the current document with updated configuration properties.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.

APL Scroll Command Element

Adds the Scroll Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an Scroll APL Command.

What does this Command do?

The Scroll command scrolls a ScrollView or Sequence forward or backward by a set number of pages.

For more info please check out the Alexa Documentation.

How to use:

  1. Fill out the Component ID field.
  2. Fill out the Distance field.

APL Scroll To Component Command Element

Adds the ScrollToComponent Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an ScrollToComponent APL Command.

What does this Command do?

Scroll forward or backward through a ScrollView or Sequence to ensure that a particular component is in view.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Component ID field.
  3. Fill out the Align field.

APL Scroll To Index Command Element

Adds the ScrollToIndex Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an ScrollToIndex APL Command.

What does this Command do?

Scroll forward or backward through a ScrollView or Sequence to ensure that a particular child component is in view.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Component ID field.
  3. Fill out the Align field.
  4. Fill out the Index field.

APL Send Event Command Element

Adds the SendEvent Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an SendEvent APL Command.

What does this Command do?

Use the SendEvent command to generate and send an event to Alexa.

For more info please check out the Alexa Documentation.

How to use:

  1. Place APL Commands and configure them
  2. Fill out the Arguments field like ${['textWasPressed','Send this data to the skill']}.
  3. Fill out the Components field like ${['idForTheTextComponent']}.

APL Set Focus Command Element

Adds the SetFocus Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an SetFocus APL Command.

What does this Command do?

Changes the actionable component that is in focus. See Focused for the actionable components that can receive and lose focus.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Component ID field.

APL Set Value Command Element

Adds the SetValue Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an SetValue APL Command.

What does this Command do?

Changes a property or binding of a component.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Template Component ID field.
  3. Fill out the Property field.
  4. Fill out the Value field.

APL Speak Item Command Element

Adds the SpeakItem Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an SpeakItem APL Command.

What does this Command do?

The SpeakItem command reads the contents of a single component on the screen. The component scrolls or pages into view if it isn't already visible.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Component ID field.
  3. Fill out the Align field.
  4. Fill out the Highlight Mode field.
  5. Fill out the Minimum Dwell Time field.

APL Speak List Command Element

Adds the SpeakList Command to an APL Command Execute Directive when placed in APL Execute Commands Element.

When to use?

When you want to send an SpeakList APL Command.

What does this Command do?

Read the contents of a range of items inside a common container. Each item will scroll into view before speech. Each item should have a speech property, but it is not required.

For more info please check out the Alexa Documentation.

How to use:

  1. Place the element in the APL Commands Element and configure it.
  2. Fill out the Component ID field.
  3. Fill out the Align field.
  4. Fill out the Count field.
  5. Fill out the Start field.
  6. Fill out the Minimum Dwell Time field.