Groups
Provides group management functionality.
The following operations are supported. For a formal definition, please review the Service Description.
-
AcceptInvite
Accepts a prior invitation (from InviteUser()) to a group.
Upon acceptance, users become full members of said group.
This method has no output.
Parameters:
long wsid : User who is accepting the invitation.
string pw : Password of said user.
long gid : Identifier of group described by the invitation.
Output:
Void -
CreateGroup
Creates a new group and returns the groupID of said group.
Parameters:
long wsid : Creator (and future owner) of a new group
string pw : Password of said user
string groupName : Unique name of group. A-Z0-9 only please.
string description : Optional description of the new group.
Output:
long : A unique identifier for the newly created group, also known as GroupID or just gid. -
DePublishTable
Target table is no longer available to members of said group.
This method has no output.
Parameters:
long wsid : User who is depublishing a table.
string pw : Password of said user.
long gid : Identifier of group from which the table will be depublished.
string tableName : Name of the table that will be depublished.
Output:
Void -
DeclineInvite
Declines a prior invitation (from InviteUser()) to a group.
User will not become a member of the group.
In order to become a member of this group in the future, this user must be reinvited.
This method has no output.
Parameters:
long wsid : User who is declining the invitation.
string pw : Password of said user.
long gid : Identifier of group described by the invitation.
Output:
Void -
DestroyGroup
Disbands a group. All tables previously published to this group will no longer be visible to ex-members of this group.
This method has no output.
Parameters:
long wsid : User who is disbanding a group. Must be either the groups owner or an admin user.
string pw : Password of said user.
long gid : Identifier of group that will be disbanded.
Output:
Void -
GetGroupTables
Returns an array of strings that contains all group tables available for a user.
String format is 'groupName.ownerid.tableName', which is the same format used in general CasJobs queries.
Parameters:
long wsid : User who is calling this method.
string pw : Password of said user.
Output:
string[] : An array of all available group tables for a given user.
-
GetGroups
Returns a list of all groups 'wsid' is a member of.
If 'wsid' has the admin priv, returns a list of all groups.
Parameters:
long wsid : User who is calling this method.
string pw : Password of said user.
Output:
Group[] : An array of relevant groups.
A Group object contains:
string Name : The name of the group.
string Description : A description of the group.
long Owner : The owner of this group.
long GID : A unique identifier for this group.
-
InviteToGroup
Invites a target user to join the given group.
Target user is not an official member of the group until the invitation is accepted.
Only a groups owner (creator) may invite other users to said group.
This method has no output.
Parameters:
long group_owner : wsid of the owner of the group to which a user is being invited
string pw : Password of said user
long user_wsid : wsid of user who is to be invited to group_id
long group_id : Group identifier (GID) of group to which user_wsid is being invited
Output:
Void -
PublishTable
Publishes a table from a user's mydb to a group of which he is a member.
This table will then become available to all members of the group.
This method has no output.
Parameters:
long wsid : User who is publishing a table.
string pw : Password of said user.
long gid : Identifier of group to which the table will be published.
string tableName : Name of the table that will be published.
Output:
Void -
RemoveUser
Removes a user from a group.
The calling user must either be the owner of the group or the same user who is to be removed.
This method has no output.
Parameters:
long caller_wsid : The identifier of the user calling RemoveUser()
string call_pw : Password of said user.
long user2remove : The identifier of the user to be removed.
long gid : The identifier of the group from which the user is to be removed.
Output:
Void