hiveUser-class: Class to contain data about a User

hiveUser-classR Documentation

Class to contain data about a User

Description

This class is the S4 representation of the User record type. It is a container for data about a given user.

Usage

hiveUser(...)

Arguments

...

Arguments containing user information to be used to populate slots of output

Slots

username

A character string specifying the name of the user. Defaults to "".

password

A character string specifying the password of the user. Defaults to NA.

group

A character string specifying the name of the default Group associated with the user. Defaults to "".

groups

A character array specifying the name(s) of the Group(s) associated with the user. Defaults to "".

superuser

A logical value specifying whether the user is a superuser. Defaults to FALSE.

confirmed

A logical value specifying whether the user has been confirmed. Defaults to FALSE.

email

A character string specifying the email address of the user. Defaults to "".

firstName

A character string specifying the first name of the user. Defaults to "".

lastName

A character string specifying the last name of the user. Defaults to "".

dateJoined

A character string specifying the date that the User record was created. Automatically populated when the record is created.

lastLogin

A character string specifying the timestamp of the User's last authentication. Automatically updated by the system.

untrashedFileUsage

A numeric value specifying the file usage of the user. Automatically updated by the system.

token

A character string specifying a token that can be used for password-free authentication. Automatically populated when the record is created.

active

A logical value specifying whether the user is active. Defaults to FALSE.

Author(s)

Adam C. Gower agower@bu.edu

See Also

group

This slot corresponds to the hiveGroup object slot name.

Functions for working with User records are described in Users.


agower/GeneHive documentation built on April 14, 2022, 5:08 a.m.