Interface ISharePointGroup

Public interface to define a SharePoint Group

Inherited Members
Namespace: PnP.Core.Model.Security
Assembly: PnP.Core.dll
Syntax
public interface ISharePointGroup : IDataModel<ISharePointGroup>, IDataModelParent, IDataModelWithContext, ISupportModules<ISharePointGroup>, IDataModelGet<ISharePointGroup>, IDataModelLoad<ISharePointGroup>, IDataModelUpdate, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel

Properties

All

A special property used to add an asterisk to a $select statement

Declaration
object All { get; }
Property Value
System.Object

AllowMembersEditMembership

Allow members to edit the group members

Declaration
bool AllowMembersEditMembership { get; set; }
Property Value
System.Boolean

AllowRequestToJoinLeave

Allow requests to join or leave the group

Declaration
bool AllowRequestToJoinLeave { get; set; }
Property Value
System.Boolean

AutoAcceptRequestToJoinLeave

Automatically accept requests to join or leave the group

Declaration
bool AutoAcceptRequestToJoinLeave { get; set; }
Property Value
System.Boolean

CanCurrentUserEditMembership

Can the current user edit the group members

Declaration
bool CanCurrentUserEditMembership { get; set; }
Property Value
System.Boolean

CanCurrentUserManageGroup

Can the current user manage the group

Declaration
bool CanCurrentUserManageGroup { get; set; }
Property Value
System.Boolean

CanCurrentUserViewMembership

Can the current user view the group membership

Declaration
bool CanCurrentUserViewMembership { get; set; }
Property Value
System.Boolean

Description

Group description. Note that HTML tags will be stripped and that the max length of the description will be limited to 511 characters

Declaration
string Description { get; set; }
Property Value
System.String

OnlyAllowMembersViewMembership

Only members can see other group members

Declaration
bool OnlyAllowMembersViewMembership { get; set; }
Property Value
System.Boolean

OwnerTitle

Group owner title

Declaration
string OwnerTitle { get; }
Property Value
System.String

RequestToJoinLeaveEmailSetting

Email configuration for the group join or leave operations

Declaration
string RequestToJoinLeaveEmailSetting { get; set; }
Property Value
System.String

Users

Members of this group Implements .
See Requesting model collections and IQueryable performance considerations to learn more.

Declaration
ISharePointUserCollection Users { get; }
Property Value
ISharePointUserCollection

Methods

AddRoleDefinitions(String[])

Adds role definitions for this group

Declaration
bool AddRoleDefinitions(params string[] names)
Parameters
System.String[] names

Returns
System.Boolean

AddRoleDefinitionsAsync(String[])

Adds role definitions for this group

Declaration
Task<bool> AddRoleDefinitionsAsync(params string[] names)
Parameters
System.String[] names

Returns
Task<System.Boolean>

AddUser(String)

Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com&quot;

Declaration
void AddUser(string loginName)
Parameters
System.String loginName

AddUserAsync(String)

Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com&quot;

Declaration
Task AddUserAsync(string loginName)
Parameters
System.String loginName

Returns
Task

AddUserBatch(Batch, String)

Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com&quot;

Declaration
void AddUserBatch(Batch batch, string loginName)
Parameters
Batch batch

System.String loginName

AddUserBatch(String)

Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com&quot;

Declaration
void AddUserBatch(string loginName)
Parameters
System.String loginName

AddUserBatchAsync(Batch, String)

Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com&quot;

Declaration
Task AddUserBatchAsync(Batch batch, string loginName)
Parameters
Batch batch

System.String loginName

Returns
Task

AddUserBatchAsync(String)

Adds a user to this group. Specify the full username, e.g. "i:0#.f|membership|user@domain.com&quot;

Declaration
Task AddUserBatchAsync(string loginName)
Parameters
System.String loginName

Returns
Task

GetRoleDefinitions()

Retrieves the role definitions for this group

Declaration
IRoleDefinitionCollection GetRoleDefinitions()
Returns
IRoleDefinitionCollection

GetRoleDefinitionsAsync()

Retrieves the role definitions for this group

Declaration
Task<IRoleDefinitionCollection> GetRoleDefinitionsAsync()
Returns
Task<IRoleDefinitionCollection>

RemoveRoleDefinitions(String[])

Removes role definitions for this group

Declaration
bool RemoveRoleDefinitions(params string[] names)
Parameters
System.String[] names

Returns
System.Boolean

RemoveRoleDefinitionsAsync(String[])

Removes role definitions for this group

Declaration
Task<bool> RemoveRoleDefinitionsAsync(params string[] names)
Parameters
System.String[] names

Returns
Task<System.Boolean>

RemoveUser(Int32)

Removes a user given its id from a group.

Declaration
void RemoveUser(int userId)
Parameters
System.Int32 userId

RemoveUserAsync(Int32)

Removes a user given its id from a group.

Declaration
Task RemoveUserAsync(int userId)
Parameters
System.Int32 userId

Returns
Task

RemoveUserBatch(Batch, Int32)

Removes a user given its id from a group.

Declaration
void RemoveUserBatch(Batch batch, int userId)
Parameters
Batch batch

System.Int32 userId

RemoveUserBatch(Int32)

Removes a user given its id from a group.

Declaration
void RemoveUserBatch(int userId)
Parameters
System.Int32 userId

RemoveUserBatchAsync(Batch, Int32)

Removes a user given its id from a group.

Declaration
Task RemoveUserBatchAsync(Batch batch, int userId)
Parameters
Batch batch

System.Int32 userId

Returns
Task

RemoveUserBatchAsync(Int32)

Removes a user given its id from a group.

Declaration
Task RemoveUserBatchAsync(int userId)
Parameters
System.Int32 userId

Returns
Task

SetUserAsOwner(Int32)

Sets a user as owner of the group.

Id of the user to set as owner
Declaration
void SetUserAsOwner(int userId)
Parameters
System.Int32 userId

SetUserAsOwnerAsync(Int32)

Sets a user as owner of the group.

Id of the user to set as owner
Declaration
Task SetUserAsOwnerAsync(int userId)
Parameters
System.Int32 userId

Returns
Task

SetUserAsOwnerBatch(Batch, Int32)

Sets a user as owner of the group.

Batch on which to execute the request Id of the user to set as owner
Declaration
void SetUserAsOwnerBatch(Batch batch, int userId)
Parameters
Batch batch

System.Int32 userId

SetUserAsOwnerBatch(Int32)

Sets a user as owner of the group.

Id of the user to set as owner
Declaration
void SetUserAsOwnerBatch(int userId)
Parameters
System.Int32 userId

SetUserAsOwnerBatchAsync(Batch, Int32)

Sets a user as owner of the group.

Batch on which to execute the request Id of the user to set as owner
Declaration
Task SetUserAsOwnerBatchAsync(Batch batch, int userId)
Parameters
Batch batch

System.Int32 userId

Returns
Task

SetUserAsOwnerBatchAsync(Int32)

Sets a user as owner of the group.

Id of the user to set as owner
Declaration
Task SetUserAsOwnerBatchAsync(int userId)
Parameters
System.Int32 userId

Returns
Task

Extension Methods