com.tenduke.events.api.model.object.UserAuthenticated Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of events-api Show documentation

Objects and interfaces describing data communicated in the 10Duke Event Data system API

There is a newer version: 1.9.0

package com.tenduke.events.api.model.object;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.tenduke.events.api.model.data.ErrorInfoFields;
import com.tenduke.events.api.model.data.RequestFields;
import com.tenduke.events.api.model.data.TimeFields;
import com.tenduke.events.api.model.data.UserIdFields;

/**
 * User authenticated.
 * @author jarkko
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface UserAuthenticated extends
        TimeFields,
        RequestFields,
        ErrorInfoFields,
        UserIdFields {

    /**
     * Gets value of flag indicating if user has requested for the system to remember the
     * authentications (user has chosen the "remember me" option).
     * @return {@code true} if user has requested for authentications to be remembered,
     *      {@code false} if user has requested for authentications not to be remembered,
     *      or {@code null} if user preference unknown / for default behaviour.
     */
    Boolean getRemember();
}