API:EPrints/DataObj/Message

From EPrints Documentation
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataObj::Message - user system message

User Comments


DESCRIPTION

This is an internal class that should not be used outside EPrints::Database.

User Comments


CORE METADATA FIELDS

User Comments


messageid (counter)

Unique identifier for this message.

User Comments


datestamp (timestamp)

The time when this message was created.

User Comments


type (set)

The type of message.

User Comments


message (longtext)

The contemts of this message.

User Comments


REFERENCES AND RELATED OBJECTS

User Comments


userid (itemref)

The user for the whom this message is intended.

User Comments


INSTANCE VARIABLES

See EPrints::DataObj.

User Comments


METHODS

User Comments


Class Methods

User Comments


get_system_field_info

$fields = EPrints::DataObj::Message->get_system_field_info

Returns an array describing the system metadata fields of the message dataset.

User Comments


get_dataset_id

$dataset = EPrints::DataObj::Message->get_dataset_id

Returns the id of the EPrints::DataSet object to which this record belongs.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

© Copyright 2023 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments