NAME

Bot::Cobalt::Core::ContextMeta::Auth - Auth list management

SYNOPSIS

            

              
              
my $auth_lev = $core->auth->level($context, $nickname);
my $auth_usr = $core->auth->username($context, $nickname);
            
          

See below for a complete description of available methods.

DESCRIPTION

A ContextMeta subclass providing context-specific authorization state information.

This is used by plugins to manage or retrieve authorized user details.

add

            

              
              
->add(
  Alias    => $alias,
  Context  => $context,
  Nickname => $nickname,
  Username => $username,
  Host     => $host,
  Level    => $lev,
  Flags    => \%flags,
);
            
          

Add a newly-authorized user.

Alias should generally be the result of a Core get_plugin_alias method call.

level

            

              
              
->level($context, $nickname)
            
          

Return recognized level for specified nickname, or 0 for unknown nicknames.

username

            

              
              
->username($context, $nickname)
            
          

Return authorized username for a specified nickname, or empty list for unknown.

host

            

              
              
->host($context, $nickname)
            
          

Return recognized hostname for a specified nickname, or empty list for unknown.

flags

            

              
              
->flags($context, $nickname)
            
          

Return flags HASH for a specified nickname, or empty hashref for unknown.

has_flag

            

              
              
->has_flag($context, $nickname, $flag)
            
          

Return boolean value indicating whether a flag is named flag is enabled.

set_flag

            

              
              
->set_flag($context, $nickname, $flag)
            
          

Turn a named flag on for the specified nickname.

drop_flag

            

              
              
->drop_flag($context, $nickname, $flag)
            
          

Remove a named flag from the specified nickname.

move

            

              
              
->move($context, $old, $new)
            
          

Move an authorized state, such as when a user changes nicknames.

AUTHOR

Jon Portnoy <avenj@cobaltirc.org>

http://www.cobaltirc.org