[This is preliminary documentation and is subject to change.]
Add member into a group based on the userDetailId
of the user which is registered
Namespace:
OfficeClip.DBLayer.AccountAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public int AddMembers( int userId, int groupId, ConfigureInfo session ) |
Visual Basic (Declaration) |
---|
Public Function AddMembers ( _ userId As Integer, _ groupId As Integer, _ session As ConfigureInfo _ ) As Integer |
Visual C++ |
---|
public: int AddMembers( int userId, int groupId, ConfigureInfo^ session ) |
Parameters
- userId
- Type: System..::.Int32
Unique id of the user.
- groupId
- Type: System..::.Int32
Id of the group in which this member has to be added.
- session
- Type: OfficeClip.Utils..::.ConfigureInfo
The user session
Return Value
- 0success
- -1the user is already present in the group
- -2email could not be sent
- -3the alert could not be sent
- -4the accounting is enabled and the user can be added to the account, but the account_id of the invitor is null for some reason.
- -5accounting is enabled and the user is already present in some other paid account If accounting is not enabled then this check is skipped
- -6accounting is enabled and the user can be added to the account, if the number of users in this account reached.
- -7by any reason the site users license Limit drops below zero.
- -8if LDAP authentication is enabled and the ldap account name being added is already used up.