Class ChangeQueryOptions

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Defines a query that is performed against the change log.

public class ChangeQueryOptions

Inheritance

object

ChangeQueryOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ChangeQueryOptions()

Initializes a new instance of the ChangeQueryOptions class.

public ChangeQueryOptions()

ChangeQueryOptions(bool, bool)

Initializes a new instance of the ChangeQueryOptions class.

public ChangeQueryOptions(bool allChangeObjectTypes, bool allChangeTypes)

Parameters

allChangeObjectTypes bool

If true, get changes for all change object types.

allChangeTypes bool

If true, get all change types.

Properties

Activity

Specifies whether activity is included in the query.

public bool Activity { get; set; }

Property Value

bool

Add

Gets or sets a value that specifies whether add changes are included in the query.

public bool Add { get; set; }

Property Value

bool

Alert

Gets or sets a value that specifies whether changes to alerts are included in the query.

public bool Alert { get; set; }

Property Value

bool

ChangeTokenEnd

Gets or sets a value that specifies the end date and end time for changes that are returned through the query.

public IChangeToken ChangeTokenEnd { get; set; }

Property Value

IChangeToken

ChangeTokenStart

Gets or sets a value that specifies the start date and start time for changes that are returned through the query. Changes after this change token are returned.

public IChangeToken ChangeTokenStart { get; set; }

Property Value

IChangeToken

ContentType

Gets or sets a value that specifies whether changes to content types are included in the query.

public bool ContentType { get; set; }

Property Value

bool

DeleteObject

Gets or sets a value that specifies whether delete changes are included in the query.

public bool DeleteObject { get; set; }

Property Value

bool

FetchLimit

The maximum number of items to return (defaults to 1000).

public long FetchLimit { get; set; }

Property Value

long

Field

Gets or sets a value that specifies whether changes to site columns are included in the query.

public bool Field { get; set; }

Property Value

bool

File

Gets or sets a value that specifies whether changes to files are included in the query.

public bool File { get; set; }

Property Value

bool

Folder

Gets or sets value that specifies whether changes to folders are included in the query.

public bool Folder { get; set; }

Property Value

bool

Group

Gets or sets a value that specifies whether changes to groups are included in the query.

public bool Group { get; set; }

Property Value

bool

GroupMembershipAdd

Gets or sets a value that specifies whether adding users to groups is included in the query.

public bool GroupMembershipAdd { get; set; }

Property Value

bool

GroupMembershipDelete

Gets or sets a value that specifies whether deleting users from the groups is included in the query.

public bool GroupMembershipDelete { get; set; }

Property Value

bool

IgnoreStartTokenNotFoundError

Ignore errors when calling GetChanges if the caller's start ChangeToken is not found in the database (exact match) or if there are no changes in the database.

public bool IgnoreStartTokenNotFoundError { get; set; }

Property Value

bool

Item

Gets or sets a value that specifies whether general changes to list items are included in the query.

public bool Item { get; set; }

Property Value

bool

LatestFirst

Gets or sets a value that specifies whether to order the results by Modified By date, most recent first.

public bool LatestFirst { get; set; }

Property Value

bool

List

Gets or sets a value that specifies whether changes to lists are included in the query.

public bool List { get; set; }

Property Value

bool

Move

Gets or sets a value that specifies whether move changes are included in the query.

public bool Move { get; set; }

Property Value

bool

Navigation

Gets or sets a value that specifies whether changes to the navigation structure of a site collection are included in the query.

public bool Navigation { get; set; }

Property Value

bool

RecursiveAll

specifies whether we return all the change logs for folder scoped query. The flag will only work for Folder query. If true, all changes in the current folder and all sub folders will be returned. Otherwise, only changes in the current folder will be returned.

public bool RecursiveAll { get; set; }

Property Value

bool

Rename

Gets or sets a value that specifies whether renaming changes are included in the query.

public bool Rename { get; set; }

Property Value

bool

RequireSecurityTrim

Specifies whether we return log with security trimming. If true, we'll return the events with security trimming.

public bool RequireSecurityTrim { get; set; }

Property Value

bool

Restore

Gets or sets a value that specifies whether restoring items from the recycle bin or from backups is included in the query.

public bool Restore { get; set; }

Property Value

bool

RoleAssignmentAdd

Gets or sets a value that specifies whether adding role assignments is included in the query.

public bool RoleAssignmentAdd { get; set; }

Property Value

bool

RoleAssignmentDelete

Gets or sets a value that specifies whether deleting role assignments is included in the query.

public bool RoleAssignmentDelete { get; set; }

Property Value

bool

RoleDefinitionAdd

Gets or sets a value that specifies whether adding role definitions is included in the query.

public bool RoleDefinitionAdd { get; set; }

Property Value

bool

RoleDefinitionDelete

Gets or sets a value that specifies whether deleting role definitions is included in the query.

public bool RoleDefinitionDelete { get; set; }

Property Value

bool

RoleDefinitionUpdate

Gets or sets a value that specifies whether modifying role definitions is included in the query.

public bool RoleDefinitionUpdate { get; set; }

Property Value

bool

SecurityPolicy

Gets or sets a value that specifies whether modifications to security policies are included in the query.

public bool SecurityPolicy { get; set; }

Property Value

bool

Site

Gets or sets a value that specifies whether changes to site collections are included in the query.

public bool Site { get; set; }

Property Value

bool

SystemUpdate

Gets or sets a value that specifies whether updates made using the item SystemUpdate method are included in the query.

public bool SystemUpdate { get; set; }

Property Value

bool

Update

Gets or sets a value that specifies whether update changes are included in the query.

public bool Update { get; set; }

Property Value

bool

User

Gets or sets a value that specifies whether changes to users are included in the query.

public bool User { get; set; }

Property Value

bool

View

Gets or sets a value that specifies whether changes to views are included in the query.

public bool View { get; set; }

Property Value

bool

Web

Gets or sets a value that specifies whether changes to Web sites are included in the query.

public bool Web { get; set; }

Property Value

bool