Docs For Class SloodleChatMessage

SloodleChatMessage

Description

Represents a single chat message

Variable Summary

mixed $id

string $message

int $timestamp

SloodleUser $user

Method Summary

SloodleChatMessage SloodleChatMessage (mixed $id, string $message, SloodleUser $user, int $timestamp)

void set (mixed $id, string $message, SloodleUser $user, int $timestamp)

Variables

mixed $id = 0 (line 310)

The ID of the message.

The type depends on the VLE, but typically is an integer.

string $message = '' (line 317)

The text of the message.

int $timestamp = 0 (line 331)

Timestamp of the message.

SloodleUser $user = null (line 324)

The user who wrote this message.

Methods

Constructor SloodleChatMessage (line 281)

Constructor - initialises members.

SloodleChatMessage SloodleChatMessage (mixed $id, string $message, SloodleUser $user, int $timestamp)

mixed $id: The ID of this message - type depends on VLE, but is typically an integer
string $message: The chat message
SloodleUser $user: The user who wrote the message
int $timestamp: The timestamp of the message

set (line 296)

Accessor - set all members in a single call.

void set (mixed $id, string $message, SloodleUser $user, int $timestamp)

mixed $id: The ID of this message - type depends on VLE, but is typically an integer
string $message: The chat message
SloodleUser $user: The user who wrote the message
int $timestamp: The timestamp of the message

Documentation generated on Fri, 17 Jul 2009 11:01:55 +0100 by phpDocumentor 1.4.0