edu.ksu.canvas.interfaces.AuthenticationLogReader Maven / Gradle / Ivy

Go to download

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

A native Java library to talk to the Canvas REST API

There is a newer version: 2.0.0

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.AuthenticationLog;

import java.io.IOException;
import java.util.List;
import java.util.Optional;

public interface AuthenticationLogReader extends CanvasReader {

    /**
     * Returns an authentication log.
     * @param accountId The account ID for the authentication log
     * @return An authentication log
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getAuthenticationLogForAccount(String accountId) throws IOException;

    /**
     * Returns an authentication log.
     * @param loginId The login ID for the authentication log
     * @return An authentication log
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getAuthenticationLogForLogin(String loginId) throws IOException;

    /**
     * Returns an authentication log.
     * @param userId The user ID for the authentication log
     * @return An authentication log
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getAuthenticationLogForUser(String userId) throws IOException;
}