use strict;
package Web::Authenticate::Result::Login;
$Web::Authenticate::Result::Login::VERSION = '0.006';
use Mouse;
#ABSTRACT: The result of calling Web::Authenticate::login.


has success => (
    isa => 'Bool',
    is => 'ro',
    required => 1,
);


has user => (
    does => 'Web::Authenticate::User::Role',
    is => 'ro',
);


has failed_authenticator => (
    does => 'Web::Authenticate::Authenticator::Role',
    is => 'ro',
);


has auth_redir => (
    does => 'Web::Authenticate::Authenticator::Redirect::Role',
    is => 'ro',
);

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Web::Authenticate::Result::Login - The result of calling Web::Authenticate::login.

=head1 VERSION

version 0.006

=head1 METHODS

=head2 success

Returns 1 if the call to L<Web::Authenticate/login> was successful, undef otherwise.

=head2 user

Returns the user that was logged in.

=head2 failed_authenticator

Returns the authenticator that caused the L<Web::Authenticate/login> to fail, if there was one.

=head2 auth_redir

Returns the L<Web::Authenticate::Authenticator::Redirect::Role> object that login used to redirect.

=head1 AUTHOR

Adam Hopkins <srchulo@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Adam Hopkins.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut
