Class CPGroupBaseClass

Namespace

Contensive.BaseClasses

Assembly

CPBase.dll

Methods and Properties for Groups

public abstract class CPGroupBaseClass

Inheritance

object

CPGroupBaseClass

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Add(string)

Add a new group

[Obsolete("Use verifyGroup to search by guid, and create with guid and name", false)]
public abstract void Add(string groupName)

Parameters

groupName string

Add(string, string)

Add a new group

[Obsolete("Use verifyGroup to search by guid, and create with guid and name", false)]
public abstract void Add(string groupName, string groupCaption)

Parameters

groupName string

groupCaption string

AddUser(int)

Add the current user to a group. Use verifyGroup(guid,name) to get groupid

public abstract void AddUser(int groupId)

Parameters

groupId int

AddUser(int, int)

Add a user to a group.

public abstract void AddUser(int groupId, int userId)

Parameters

groupId int

userId int

AddUser(int, int, DateTime)

Add a user to a group.

public abstract void AddUser(int groupId, int userId, DateTime dateExpires)

Parameters

groupId int

userId int

dateExpires DateTime

AddUser(string)

Add the current user to a group. If argument is numeric, record is referenced by Id. If argument is guid, record is referenced by ccGuid. Otherwise argument is name.

public abstract void AddUser(string groupNameIdOrGuid)

Parameters

groupNameIdOrGuid string

AddUser(string, int)

Add a user to a group. If argument is numeric, record is referenced by Id. If argument is guid, record is referenced by ccGuid. Otherwise argument is name.

public abstract void AddUser(string groupNameIdOrGuid, int userId)

Parameters

groupNameIdOrGuid string

userId int

AddUser(string, int, DateTime)

Add a user to a group. If argument is numeric, record is referenced by Id. If argument is guid, record is referenced by ccGuid. Otherwise argument is name.

public abstract void AddUser(string groupNameIdOrGuid, int userId, DateTime dateExpires)

Parameters

groupNameIdOrGuid string

userId int

dateExpires DateTime

Delete(int)

Delete a group.

public abstract void Delete(int groupId)

Parameters

groupId int

Delete(string)

Delete a group. If argument is numeric, record is referenced by Id. If argument is guid, record is referenced by ccGuid. Otherwise argument is name.

public abstract void Delete(string groupNameIdOrGuid)

Parameters

groupNameIdOrGuid string

GetId(string)

Get a group Id. If argument is guid, record is referenced by ccGuid. Otherwise argument is name.

public abstract int GetId(string groupNameOrGuid)

Parameters

groupNameOrGuid string

Returns

int

GetName(int)

Get a group Name

public abstract string GetName(int groupId)

Parameters

groupId int

Returns

string

GetName(string)

Get a group name. If argument is numeric, record is referenced by Id. Otherwise record is referenced by ccGuid.

public abstract string GetName(string GroupIdOrGuid)

Parameters

GroupIdOrGuid string

Returns

string

RemoveUser(int)

Remove the current user from a group

public abstract void RemoveUser(int groupId)

Parameters

groupId int

RemoveUser(int, int)

Remove a user from a group

public abstract void RemoveUser(int groupId, int userId)

Parameters

groupId int

userId int

RemoveUser(string)

Remove the current user from a group

public abstract void RemoveUser(string groupNameOrGuid)

Parameters

groupNameOrGuid string

RemoveUser(string, int)

Remove a user from a group

public abstract void RemoveUser(string groupNameOrGuid, int userId)

Parameters

groupNameOrGuid string

userId int

exists(string)

Verify a group exists, create it if it does not

public abstract bool exists(string groupGuid)

Parameters

groupGuid string

The guid of the group to be found.

Returns

bool

exists(string, out int)

Verify a group exists, create it if it does not

public abstract bool exists(string groupGuid, out int groupId)

Parameters

groupGuid string

The guid of the group to be found.

groupId int

If the group exists, the id is returned. if not found, 0 is returned,

Returns

bool

verifyGroup(string, string)

Verify a group exists, create it if it does not. Return the id of the group.

public abstract int verifyGroup(string groupGuid, string groupName)

Parameters

groupGuid string

groupName string

Returns

int

The id of the verified group

verifyGroup(string, string, string)

Verify a group exists, create it if it does not. Return the id of the group.

public abstract int verifyGroup(string groupGuid, string groupName, string groupCaption)

Parameters

groupGuid string

groupName string

groupCaption string

Returns

int

The id of the verified group