Members Object

The Members object represents the set of members belonging to a web. The methods of the Members object allow addition and deletion of members in a web as well as testing if a given user is a member. Instantiating Member objects by name or email is done with Members object methods below. Note that the string arguments require quotes. The acceptable values for the group_string argument used below are: "Owner", "Administrators", "Staff", "Members", and "Guests".

Prototype Properties

signUpMode

signUpMode denotes how members sign up for the given web. A web can have members sign up in one of four ways. The sign up method is selected in the web's "Settings" tab:
(1) Signup_Invite indicates "By invitation only", (2) Signup_Approval indicates "All visitors may sign up, and Administrators must approve", (3) Signup_SelfLoggedOn indicates "Users logged on to this domain may sign up", (4) Signup_Self indicates that "All visitors may sign up". If testing for which case is in practice, use these properties for comparison: Members.Signup_Invite, Members.Signup_Approval, Members.Signup_SelfLoggedOn, or Members.Signup_Self.
For example, if (Members.signUpMode == Members.Signup_Invite)

Prototype Methods

add	Adds a member to a Web.
delete	Deletes a member from the Web.
getMemberFromEmail	Retrieves a member of the web via their email address.
getMemberFromName	Retrieves a member of the web via their user name.
isDomainUser	Checks to see if a user is registered in a domain.
isValidEmail	Tests a string to see if it is a valid email address.

The following example function shows how to add members from script. The code below demonstrates the usage of the isDomainUser() method.

 webcall function AddMember(email_addr, group)
{
try
{
var mem = Members.getMemberFromEmail(email_addr);
if (mem == null)
{
Members.add(email_addr, group);
response.write(email_addr + ": member added to "
+ group + " group. (SUCCESS)\n");
}
else if (mem.isInGroup("Owner"))
{
response.write(email_addr
+ ": member is owner. (NO CHANGE)\n");
}
else if (!mem.isInGroup(group))
{
mem.changeGroup(group);
response.write(email_addr
+ ": member group changed to "
+ group + ". (SUCCESS)\n");
}
else
{
response.write(email_addr
+ ": already member of "
+ group + " group. (NO CHANGE)\n");
}
}
catch (err)
{
response.write(email_addr
+ ": member not added. (ERROR)\n");
}
}

You might call this function from the URL as follows:

http://myweb.dataweb.com/ManageMembers.ws?_fn= AddMember&email_addr=topdog@dataweb.com&group=members

webcall function membsDomainTest()
{
var mem_email = "jennifer@dataweb.com";
var m = Members.getMemberFromEmail(mem_email);
if(m==null)
response.write("Did not find " + mem_email +
" in Members list.\n");
else
{
if(Members.isDomainUser(mem_email))
{
response.write(mem_email +" is registered with
this domain and will remain on this web.\n");
}
else
{
response.write(mem_email +" is *not* registered
with this domain and will be removed from
this web.\n");
Members.delete(mem_email);
}
}
}