Interface ISharePointGroup
Public interface to define a SharePoint Group
public interface ISharePointGroup : IDataModel<ISharePointGroup>, IDataModelParent, IDataModelWithContext, ISupportModules<ISharePointGroup>, IDataModelGet<ISharePointGroup>, IDataModelLoad<ISharePointGroup>, IDataModelUpdate, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel- Inherited Members
- Extension Methods
Properties
All
A special property used to add an asterisk to a $select statement
object All { get; }Property Value
AllowMembersEditMembership
Allow members to edit the group members
bool AllowMembersEditMembership { get; set; }Property Value
AllowRequestToJoinLeave
Allow requests to join or leave the group
bool AllowRequestToJoinLeave { get; set; }Property Value
AutoAcceptRequestToJoinLeave
Automatically accept requests to join or leave the group
bool AutoAcceptRequestToJoinLeave { get; set; }Property Value
CanCurrentUserEditMembership
Can the current user edit the group members
bool CanCurrentUserEditMembership { get; set; }Property Value
CanCurrentUserManageGroup
Can the current user manage the group
bool CanCurrentUserManageGroup { get; set; }Property Value
CanCurrentUserViewMembership
Can the current user view the group membership
bool CanCurrentUserViewMembership { get; set; }Property Value
Description
Group description. Note that HTML tags will be stripped and that the max length of the description will be limited to 511 characters
string Description { get; set; }Property Value
OnlyAllowMembersViewMembership
Only members can see other group members
bool OnlyAllowMembersViewMembership { get; set; }Property Value
OwnerTitle
Group owner title
string OwnerTitle { get; }Property Value
RequestToJoinLeaveEmailSetting
Email configuration for the group join or leave operations
string RequestToJoinLeaveEmailSetting { get; set; }Property Value
Users
Members of this group
Implements IQueryable<T>.
See Requesting model collections
and IQueryable performance considerations to learn more.
ISharePointUserCollection Users { get; }Property Value
Methods
AddRoleDefinitions(params string[])
Adds role definitions for this group
bool AddRoleDefinitions(params string[] names)Parameters
namesstring[]
Returns
AddRoleDefinitionsAsync(params string[])
Adds role definitions for this group
Task<bool> AddRoleDefinitionsAsync(params string[] names)Parameters
namesstring[]
Returns
AddUser(string)
Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com"
void AddUser(string loginName)Parameters
loginNamestring
AddUserAsync(string)
Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com"
Task AddUserAsync(string loginName)Parameters
loginNamestring
Returns
AddUserBatch(Batch, string)
Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com"
void AddUserBatch(Batch batch, string loginName)Parameters
AddUserBatch(string)
Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com"
void AddUserBatch(string loginName)Parameters
loginNamestring
AddUserBatchAsync(Batch, string)
Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com"
Task AddUserBatchAsync(Batch batch, string loginName)Parameters
Returns
AddUserBatchAsync(string)
Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com"
Task AddUserBatchAsync(string loginName)Parameters
loginNamestring
Returns
GetRoleDefinitions()
Retrieves the role definitions for this group
IRoleDefinitionCollection GetRoleDefinitions()Returns
GetRoleDefinitionsAsync()
Retrieves the role definitions for this group
Task<IRoleDefinitionCollection> GetRoleDefinitionsAsync()Returns
RemoveRoleDefinitions(params string[])
Removes role definitions for this group
bool RemoveRoleDefinitions(params string[] names)Parameters
namesstring[]
Returns
RemoveRoleDefinitionsAsync(params string[])
Removes role definitions for this group
Task<bool> RemoveRoleDefinitionsAsync(params string[] names)Parameters
namesstring[]
Returns
RemoveUser(int)
Removes a user given its id from a group.
void RemoveUser(int userId)Parameters
userIdint
RemoveUserAsync(int)
Removes a user given its id from a group.
Task RemoveUserAsync(int userId)Parameters
userIdint
Returns
RemoveUserBatch(Batch, int)
Removes a user given its id from a group.
void RemoveUserBatch(Batch batch, int userId)Parameters
RemoveUserBatch(int)
Removes a user given its id from a group.
void RemoveUserBatch(int userId)Parameters
userIdint
RemoveUserBatchAsync(Batch, int)
Removes a user given its id from a group.
Task RemoveUserBatchAsync(Batch batch, int userId)Parameters
Returns
RemoveUserBatchAsync(int)
Removes a user given its id from a group.
Task RemoveUserBatchAsync(int userId)Parameters
userIdint
Returns
SetUserAsOwner(int)
Sets a user as owner of the group.
Id of the user to set as ownervoid SetUserAsOwner(int userId)Parameters
userIdint
SetUserAsOwnerAsync(int)
Sets a user as owner of the group.
Id of the user to set as ownerTask SetUserAsOwnerAsync(int userId)Parameters
userIdint
Returns
SetUserAsOwnerBatch(Batch, int)
Sets a user as owner of the group.
Batch on which to execute the request Id of the user to set as ownervoid SetUserAsOwnerBatch(Batch batch, int userId)Parameters
SetUserAsOwnerBatch(int)
Sets a user as owner of the group.
Id of the user to set as ownervoid SetUserAsOwnerBatch(int userId)Parameters
userIdint
SetUserAsOwnerBatchAsync(Batch, int)
Sets a user as owner of the group.
Batch on which to execute the request Id of the user to set as ownerTask SetUserAsOwnerBatchAsync(Batch batch, int userId)Parameters
Returns
SetUserAsOwnerBatchAsync(int)
Sets a user as owner of the group.
Id of the user to set as ownerTask SetUserAsOwnerBatchAsync(int userId)Parameters
userIdint