Class InviteOptions

Options that can be set when inviting users to an item

Inheritance

object

InviteOptionsBase

InviteOptions

Inherited Members

InviteOptionsBase.CreateDriveRecipient(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: PnP.Core.Model.Security

Assembly: PnP.Core.dll

Syntax

public class InviteOptions : InviteOptionsBase

Properties

ExpirationDateTime

Specify the DateTime after which the permission expires. Note: Available on OneDrive for Business, SharePoint, and premium personal OneDrive accounts.

Declaration

public DateTime ExpirationDateTime { get; set; }

Property Value

DateTime

Message

A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.

Declaration

public string Message { get; set; }

Property Value

string

Recipients

A collection of recipients who will receive access and the sharing invitation.

Declaration

public List<IDriveRecipient> Recipients { get; set; }

Property Value

List<IDriveRecipient>

RequireSignIn

Specifies where the recipient of the invitation is required to sign-in to view the shared item

Declaration

public bool RequireSignIn { get; set; }

Property Value

bool

Roles

Specify the roles that are be granted to the recipients of the sharing invitation.

Declaration

public List<PermissionRole> Roles { get; set; }

Property Value

List<PermissionRole>

SendInvitation

Specifies if an email or post is generated (false) or if the permission is just created (true).

Declaration

public bool SendInvitation { get; set; }

Property Value

bool