io.klerch.alexa.state.model.AlexaStateSave Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alexa-skills-kit-states-java Show documentation

This SDK is an extension to the Alexa Skills SDK for Java. It provides a framework for managing state of POJO models in a variety of persistence stores in an Alexa skill.

There is a newer version: 1.1.0

Show newest version

/**
 * Made by Kay Lerch (https://twitter.com/KayLerch)
 *
 * Attached license applies.
 * This library is licensed under GNU GENERAL PUBLIC LICENSE Version 3 as of 29 June 2007
 */
package io.klerch.alexa.state.model;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A field having this annotation will be saved and loaded by AlexaStateHandlers
 * as long as they don't have the AlexaStateIgnore-tag. Use the scope parameter to define in which
 * scope (Session, User, Application) this consideration should apply.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface AlexaStateSave {
    /**
     * The scope in which the field is considered by AlexaStateHandlers.
     * @return The scope in which the field is considered by AlexaStateHandlers.
     */
    AlexaScope Scope() default AlexaScope.SESSION;
}