Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

Chat Template

changeUserStatus()

Change status of user

Syntax

number = rb.chat.changeUserStatus(roomID, adminContactID, key, contactID, newFlags)

Parameters

The 'changeUserStatus' method takes 5 parameters:

Name Type/Value Range/Length Description
roomIDnumber  Required. ID of the room we want to poll
adminContactIDnumber  Required. ID of the admin member making the change
keystring  Required. A key associated with the admin user.
contactIDnumber  Required. The ID of the member who is to have flags changed
newFlagsnumber  Required. New flags for this member

Results

The 'changeUserStatus' method returns number:

Type/Value Range/Length Description
number   Change the flags associated with a user

Remarks

This is an admin function to allow the conversation moderator to change the flags on another user. The moderator must have the moderate or admin flag set.

Whitebeam release 1.3.36
(loadtime : 180ms)