Whitebeam Object Definition

Whitebeam Object Definition

Method Description

MessageGroup.removeMessage()

Deletes a single article from the message store.

Syntax

MessageGroup.message = MessageGroup.removeMessage(article)

Parameters

The 'MessageGroup.removeMessage' method takes 1 parameter:

Name	Type/Value	Range/Length	Description
article	struct MessageGroup.message	see definition	Required. The header of an existing message, containing at least a valid messageID property

Results

The 'MessageGroup.removeMessage' method returns structure:

Type/Value	Range/Length	Description
struct MessageGroup.message	see definition	The immediately previous article to the one deleted in it's thread, or The first article in the group which isn't the deleted article if the article was the first or only article in the thread.

Remarks

Returns null in both the case where the article couldn't be deleted, and the case where the article was the only one in the group.

Whitebeam release 1.3.36

(loadtime : 9ms)